summaryrefslogtreecommitdiff
path: root/home/.oh-my-zsh/plugins/node/README.md
diff options
context:
space:
mode:
authornavewindre <boneyaard@gmail.com>2025-07-13 06:42:05 +0200
committernavewindre <boneyaard@gmail.com>2025-07-13 06:42:05 +0200
commit02f14a9cb152561a5e44062aac79f3b700403b40 (patch)
tree2db8ebda3b7f6f8777783aeb5c60018e6e1359d8 /home/.oh-my-zsh/plugins/node/README.md
parentcbbdeb2f6b40a102a829f0c47cff052937231f00 (diff)
omz
Diffstat (limited to 'home/.oh-my-zsh/plugins/node/README.md')
-rw-r--r--home/.oh-my-zsh/plugins/node/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/home/.oh-my-zsh/plugins/node/README.md b/home/.oh-my-zsh/plugins/node/README.md
new file mode 100644
index 0000000..911b669
--- /dev/null
+++ b/home/.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
+```