diff options
Diffstat (limited to 'oh-my-zsh/plugins/node/README.md')
| -rw-r--r-- | oh-my-zsh/plugins/node/README.md | 19 |
1 files changed, 19 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 +``` |