summaryrefslogtreecommitdiff
path: root/dot-oh-my-zsh/plugins/node
diff options
context:
space:
mode:
authorlittleblack111 <littleblack11111@gmail.com>2024-06-03 19:56:39 +0800
committerlittleblack111 <littleblack11111@gmail.com>2024-06-03 19:56:39 +0800
commitca968c4e5040f1ff4b5b5e12d9312360d807dcc1 (patch)
tree9900920e8f566794560c1519678e344351d2803b /dot-oh-my-zsh/plugins/node
parent5f3deaff0bf006a1a353e57b82ad48c0e8f143bc (diff)
added submodules, change . -> dot (see man stow --dotfiles)
Diffstat (limited to 'dot-oh-my-zsh/plugins/node')
-rw-r--r--dot-oh-my-zsh/plugins/node/README.md19
-rw-r--r--dot-oh-my-zsh/plugins/node/node.plugin.zsh6
2 files changed, 25 insertions, 0 deletions
diff --git a/dot-oh-my-zsh/plugins/node/README.md b/dot-oh-my-zsh/plugins/node/README.md
new file mode 100644
index 00000000..911b6693
--- /dev/null
+++ b/dot-oh-my-zsh/plugins/node/README.md
@@ -0,0 +1,19 @@
+# node plugin
+
+This plugin adds `node-docs` function that opens specific section in [Node.js](https://nodejs.org)
+documentation (depending on the installed version).
+
+To use it, add `node` to the plugins array of your zshrc file:
+
+```zsh
+plugins=(... node)
+```
+
+## Usage
+
+```zsh
+# Opens https://nodejs.org/docs/latest-v10.x/api/fs.html
+$ node-docs fs
+# Opens https://nodejs.org/docs/latest-v10.x/api/path.html
+$ node-docs path
+```
diff --git a/dot-oh-my-zsh/plugins/node/node.plugin.zsh b/dot-oh-my-zsh/plugins/node/node.plugin.zsh
new file mode 100644
index 00000000..e196662c
--- /dev/null
+++ b/dot-oh-my-zsh/plugins/node/node.plugin.zsh
@@ -0,0 +1,6 @@
+# Open the node api for your current version to the optional section.
+# TODO: Make the section part easier to use.
+function node-docs {
+ local section=${1:-all}
+ open_command "https://nodejs.org/docs/$(node --version)/api/$section.html"
+}