mirror of https://github.com/nodejs/node.git
39 lines
713 B
Markdown
39 lines
713 B
Markdown
npm-docs(1) -- Docs for a package in a web browser maybe
|
|
========================================================
|
|
|
|
## SYNOPSIS
|
|
|
|
npm docs <pkgname>
|
|
npm home <pkgname>
|
|
|
|
## DESCRIPTION
|
|
|
|
This command tries to guess at the likely location of a package's
|
|
documentation URL, and then tries to open it using the `--browser`
|
|
config param.
|
|
|
|
## CONFIGURATION
|
|
|
|
### browser
|
|
|
|
* Default: OS X: `"open"`, others: `"google-chrome"`
|
|
* Type: String
|
|
|
|
The browser that is called by the `npm docs` command to open websites.
|
|
|
|
### registry
|
|
|
|
* Default: https://registry.npmjs.org/
|
|
* Type: url
|
|
|
|
The base URL of the npm package registry.
|
|
|
|
|
|
## SEE ALSO
|
|
|
|
* npm-view(1)
|
|
* npm-publish(1)
|
|
* npm-registry(1)
|
|
* npm-config(1)
|
|
* npm-json(1)
|