npm-docs.1 1.23 KB
Newer Older
Nicolas Widart's avatar
Nicolas Widart committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
.TH "NPM\-DOCS" "1" "October 2014" "" ""
.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 (with no args in a package dir)
npm home [<pkgname> [<pkgname> \.\.\.]]
npm home (with no args in a package dir)
.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\fR
config param\. You can pass multiple package names at once\. If no
package name is provided, it will search for a \fBpackage\.json\fR in
the current folder and use the \fBname\fR property\.
.SH CONFIGURATION
.SS browser
.RS 0
.IP \(bu 2
Default: OS X: \fB"open"\fR, Windows: \fB"start"\fR, Others: \fB"xdg\-open"\fR
.IP \(bu 2
Type: String

.RE
.P
The browser that is called by the \fBnpm docs\fR 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