2018-10-03 08:59:30 -07:00
|
|
|
# node plugin
|
|
|
|
|
|
2020-03-11 11:57:46 -07:00
|
|
|
This plugin adds `node-docs` function that opens specific section in [Node.js](https://nodejs.org)
|
|
|
|
|
documentation (depending on the installed version).
|
|
|
|
|
|
2018-10-03 08:59:30 -07:00
|
|
|
To use it, add `node` to the plugins array of your zshrc file:
|
2020-03-11 11:57:46 -07:00
|
|
|
|
2018-10-03 08:59:30 -07:00
|
|
|
```zsh
|
|
|
|
|
plugins=(... node)
|
|
|
|
|
```
|
|
|
|
|
|
2020-03-11 11:57:46 -07:00
|
|
|
## Usage
|
2018-10-03 08:59:30 -07: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-03-11 11:57:46 -07:00
|
|
|
$ node-docs path
|
2018-10-03 08:59:30 -07:00
|
|
|
```
|
