conf2/zsh/.oh-my-zsh/plugins/node/README.md

20 lines
431 B
Markdown
Raw Normal View History

2019-01-12 15:47:23 +00:00
# node plugin
2020-06-11 14:41:32 +00:00
This plugin adds `node-docs` function that opens specific section in [Node.js](https://nodejs.org)
documentation (depending on the installed version).
2019-01-12 15:47:23 +00:00
To use it, add `node` to the plugins array of your zshrc file:
2020-06-11 14:41:32 +00:00
2019-01-12 15:47:23 +00:00
```zsh
plugins=(... node)
```
2020-06-11 14:41:32 +00:00
## Usage
2019-01-12 15:47:23 +00:00
```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
2020-06-11 14:41:32 +00:00
$ node-docs path
2019-01-12 15:47:23 +00:00
```