diff options
| author | Denys Dovhan <denysd96@gmail.com> | 2018-10-03 18:59:30 +0300 |
|---|---|---|
| committer | Marc Cornellà <marc.cornella@live.com> | 2018-10-03 17:59:30 +0200 |
| commit | af7d165a7f84f83a4c5d9f434a5320a5844d8ad3 (patch) | |
| tree | c382ecd8d3e1993e33c980849d1057dd893f75ce /plugins/node/README.md | |
| parent | 9b19ca28719c7cd0034e1f30f1c3882183180518 (diff) | |
| download | zsh-af7d165a7f84f83a4c5d9f434a5320a5844d8ad3.tar.gz zsh-af7d165a7f84f83a4c5d9f434a5320a5844d8ad3.tar.bz2 zsh-af7d165a7f84f83a4c5d9f434a5320a5844d8ad3.zip | |
node: add README (#7201)
Diffstat (limited to 'plugins/node/README.md')
| -rw-r--r-- | plugins/node/README.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/plugins/node/README.md b/plugins/node/README.md new file mode 100644 index 000000000..c392dc0bf --- /dev/null +++ b/plugins/node/README.md @@ -0,0 +1,16 @@ +# node plugin + +To use it, add `node` to the plugins array of your zshrc file: +```zsh +plugins=(... node) +``` + +This plugin adds `node-docs` function that open specific section in [Node.js](https://nodejs.org) documentation (depending on the installed version). +For example: + +```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 +``` |