aefc621e67
PR-URL: https://github.com/nodejs/node/pull/38628 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
72 lines
1.6 KiB
Groff
72 lines
1.6 KiB
Groff
.TH "NPM\-DOCS" "1" "May 2021" "" ""
|
|
.SH "NAME"
|
|
\fBnpm-docs\fR \- Open documentation for a package in a web browser
|
|
.SS Synopsis
|
|
.P
|
|
.RS 2
|
|
.nf
|
|
npm docs [<pkgname> [<pkgname> \.\.\.]]
|
|
|
|
aliases: 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 or Boolean
|
|
|
|
.RE
|
|
.P
|
|
The browser that is called by the \fBnpm docs\fP command to open websites\.
|
|
.P
|
|
Set to \fBfalse\fP to suppress browser behavior and instead print urls to
|
|
terminal\.
|
|
.P
|
|
Set to \fBtrue\fP to use default system URL opener\.
|
|
.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 workspaces
|
|
.P
|
|
Enables workspaces context while searching the \fBpackage\.json\fP in the
|
|
current folder\. Documentation urls for the packages named in each
|
|
workspace will be opened\.
|
|
.SS workspace
|
|
.P
|
|
Enables workspaces context and limits results to only those specified by
|
|
this config item\. Only the documentation urls for the packages named in
|
|
the workspaces given here will be opened\.
|
|
.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
|