diff options
author | Luiz Guilherme Fonseca Rosa <luizguilhermefr@gmail.com> | 2018-10-08 10:20:10 -0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-10-08 10:20:10 -0300 |
commit | ed401bc55af2e5b08d1ff903111a65838473ad9d (patch) | |
tree | 621f7623dedf79dd9117a20e84c0997eac8217e3 /plugins/node/README.md | |
parent | c2113d7cc67e2865a4692918198fba27e8360fe5 (diff) | |
parent | 7b29684a3087c881f240ebb74bd387c69f0ffcc6 (diff) | |
download | zsh-ed401bc55af2e5b08d1ff903111a65838473ad9d.tar.gz zsh-ed401bc55af2e5b08d1ff903111a65838473ad9d.tar.bz2 zsh-ed401bc55af2e5b08d1ff903111a65838473ad9d.zip |
Merge branch 'master' into master
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 +``` |