mirror of
https://github.com/dcarrillo/prezto.git
synced 2025-07-01 22:09:25 +00:00
general: Reformat documentation with better formatting and wording
General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
This commit is contained in:
committed by
Indrajit Raychaudhuri
parent
8edc5e9323
commit
d80e393f78
@ -1,38 +1,33 @@
|
||||
Node.js
|
||||
=======
|
||||
# Node.js
|
||||
|
||||
Provides utility functions for [Node.js][1], loads the Node Version Manager, and
|
||||
enables [npm][2] completion.
|
||||
enables [*npm*][2] completion.
|
||||
|
||||
nvm
|
||||
---
|
||||
## nvm
|
||||
|
||||
[nvm][5] allows for managing multiple, isolated Node.js installations in the
|
||||
[*nvm*][5] allows for managing multiple, isolated Node.js installations in the
|
||||
home directory.
|
||||
|
||||
This will be loaded automatically if nvm is installed in `$NVM_DIR`,
|
||||
`~/.nvm`, or nvm is installed with homebrew.
|
||||
*~/.nvm*, or nvm is installed with homebrew.
|
||||
|
||||
nodenv
|
||||
------
|
||||
## nodenv
|
||||
|
||||
[nodenv][6] does one thing well. nodenv is concerned solely with switching
|
||||
Node versions. It's simple and predictable, Just Works, and is rock solid in
|
||||
production. nodenv is forked from the popular [rbenv][7].
|
||||
[*nodenv*][6] does one thing well - it is concerned solely with switching
|
||||
Node versions. It is simple and predictable, Just Works, and is rock solid in
|
||||
production. nodenv is forked from the popular [*rbenv*][7].
|
||||
|
||||
This will be loaded automatically if nodenv is installed in `$NODENV_ROOT`,
|
||||
`~/.nodenv`, or `nodenv` is on the path.
|
||||
*~/.nodenv*, or `nodenv` is on the path.
|
||||
|
||||
Functions
|
||||
---------
|
||||
## Functions
|
||||
|
||||
- `node-doc` opens the Node.js online [API documentation][3] in the default
|
||||
browser.
|
||||
- `node-info` exposes information about the Node.js environment via the
|
||||
`$node_info` associative array.
|
||||
- `node-doc` opens the Node.js online [API documentation][3] in the default
|
||||
browser.
|
||||
- `node-info` exposes information about the Node.js environment via the
|
||||
`$node_info` associative array.
|
||||
|
||||
Theming
|
||||
-------
|
||||
## Theming
|
||||
|
||||
To display the version number of the current Node.js version, define the
|
||||
following style inside the `prompt_name_setup` function.
|
||||
@ -45,13 +40,12 @@ zstyle ':prezto:module:node:info:version' format 'version:%v'
|
||||
Then add `$node_info[version]` to either `$PROMPT` or `$RPROMPT` and call
|
||||
`node-info` in `prompt_name_preexec` hook function.
|
||||
|
||||
Authors
|
||||
-------
|
||||
## Authors
|
||||
|
||||
*The authors of this module should be contacted via the [issue tracker][4].*
|
||||
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
- [Zeh Rizzatti](https://github.com/zehrizzatti)
|
||||
- [Sorin Ionescu](https://github.com/sorin-ionescu)
|
||||
- [Zeh Rizzatti](https://github.com/zehrizzatti)
|
||||
|
||||
[1]: http://nodejs.org
|
||||
[2]: http://npmjs.org
|
||||
|
Reference in New Issue
Block a user