|
|
|
|
.TH "NPM\-DOCS" "1" "April 2016" "" ""
|
|
|
|
|
.SH "NAME"
|
|
|
|
|
\fBnpm-docs\fR \- Docs for a package in a web browser maybe
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.P
|
|
|
|
|
.RS 2
|
|
|
|
|
.nf
|
|
|
|
|
npm docs [<pkgname> [<pkgname> \.\.\.]]
|
|
|
|
|
npm docs \.
|
|
|
|
|
npm home [<pkgname> [<pkgname> \.\.\.]]
|
|
|
|
|
npm home \.
|
|
|
|
|
.fi
|
|
|
|
|
.RE
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
.P
|
|
|
|
|
This command tries to guess at the likely location of a package's
|
|
|
|
|
documentation URL, and then tries to open it using the \fB\-\-browser\fP
|
|
|
|
|
config param\. You can pass multiple package names at once\. If no
|
|
|
|
|
package name is provided, it will search for a \fBpackage\.json\fP in
|
|
|
|
|
the current folder and use the \fBname\fP property\.
|
|
|
|
|
.SH CONFIGURATION
|
|
|
|
|
.SS browser
|
|
|
|
|
.RS 0
|
|
|
|
|
.IP \(bu 2
|
|
|
|
|
Default: OS X: \fB"open"\fP, Windows: \fB"start"\fP, Others: \fB"xdg\-open"\fP
|
|
|
|
|
.IP \(bu 2
|
|
|
|
|
Type: String
|
|
|
|
|
|
|
|
|
|
.RE
|
|
|
|
|
.P
|
|
|
|
|
The browser that is called by the \fBnpm docs\fP command to open websites\.
|
|
|
|
|
.SS registry
|
|
|
|
|
.RS 0
|
|
|
|
|
.IP \(bu 2
|
|
|
|
|
Default: https://registry\.npmjs\.org/
|
|
|
|
|
.IP \(bu 2
|
|
|
|
|
Type: url
|
|
|
|
|
|
|
|
|
|
.RE
|
|
|
|
|
.P
|
|
|
|
|
The base URL of the npm package registry\.
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.RS 0
|
|
|
|
|
.IP \(bu 2
|
|
|
|
|
npm help view
|
|
|
|
|
.IP \(bu 2
|
|
|
|
|
npm help publish
|
|
|
|
|
.IP \(bu 2
|
|
|
|
|
npm help 7 registry
|
|
|
|
|
.IP \(bu 2
|
|
|
|
|
npm help config
|
|
|
|
|
.IP \(bu 2
|
|
|
|
|
npm help 7 config
|
|
|
|
|
.IP \(bu 2
|
|
|
|
|
npm help 5 npmrc
|
|
|
|
|
.IP \(bu 2
|
|
|
|
|
npm help 5 package\.json
|
|
|
|
|
|
|
|
|
|
.RE
|
|
|
|
|
|
