2014-09-17 06:38:50 +08:00
|
|
|
.TH "NPM\-DOCS" "3" "September 2014" "" ""
|
2011-11-27 01:21:03 +08:00
|
|
|
.SH "NAME"
|
2014-09-25 05:41:07 +08:00
|
|
|
\fBnpm-docs\fR \- Docs for a package in a web browser maybe
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.P
|
|
|
|
|
.RS 2
|
|
|
|
|
.EX
|
2011-11-27 01:21:03 +08:00
|
|
|
npm\.commands\.docs(package, callback)
|
2014-09-25 05:41:07 +08:00
|
|
|
.EE
|
|
|
|
|
.RE
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
.P
|
|
|
|
|
This command tries to guess at the likely location of a package's
|
2011-11-27 01:21:03 +08:00
|
|
|
documentation URL, and then tries to open it using the \fB\-\-browser\fR
|
|
|
|
|
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\.
|
2014-09-25 05:41:07 +08:00
|
|
|
|
