blob: f8ccc15a1ef0c8392288ed96fec0cc47c0121b38 [file] [log] [blame]
.TH "NPM\-DOCS" "3" "June 2016" "" ""
.SH "NAME"
\fBnpm-docs\fR \- Docs for a package in a web browser maybe
.SH SYNOPSIS
.P
.RS 2
.nf
npm\.commands\.docs(package, callback)
.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\.
.P
Like other commands, the first parameter is an array\. This command only
uses the first element, which is expected to be a package name with an
optional version number\.
.P
This command will launch a browser, so this command may not be the most
friendly for programmatic use\.