npm-docs.1

.TH "NPM\-DOCS" "1" "April 2022" "" ""
.SH "NAME"
\fBnpm-docs\fR \- Docs for a package in a web browser maybe
.SS Synopsis
.P
.RS 2
.nf
npm docs [<pkgname> [<pkgname> \.\.\.]]
npm docs \.
npm home [<pkgname> [<pkgname> \.\.\.]]
npm home \.
.fi
.RE
.SS 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\.
.SS 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\.
.SS See Also
.RS 0
.IP \(bu 2
npm help view
.IP \(bu 2
npm help publish
.IP \(bu 2
npm help registry
.IP \(bu 2
npm help config
.IP \(bu 2
npm help npmrc
.IP \(bu 2
npm help package\.json

.RE