summaryrefslogtreecommitdiff
path: root/oh-my-zsh/plugins/node
diff options
context:
space:
mode:
Diffstat (limited to 'oh-my-zsh/plugins/node')
-rw-r--r--oh-my-zsh/plugins/node/README.md19
-rw-r--r--oh-my-zsh/plugins/node/node.plugin.zsh6
2 files changed, 25 insertions, 0 deletions
diff --git a/oh-my-zsh/plugins/node/README.md b/oh-my-zsh/plugins/node/README.md
new file mode 100644
index 0000000..911b669
--- /dev/null
+++ b/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/oh-my-zsh/plugins/node/node.plugin.zsh b/oh-my-zsh/plugins/node/node.plugin.zsh
new file mode 100644
index 0000000..e196662
--- /dev/null
+++ b/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"
+}