summaryrefslogtreecommitdiff
path: root/deps/npm/doc/cli/docs.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/doc/cli/docs.md')
-rw-r--r--deps/npm/doc/cli/docs.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/deps/npm/doc/cli/docs.md b/deps/npm/doc/cli/docs.md
new file mode 100644
index 0000000000..26b2455dd8
--- /dev/null
+++ b/deps/npm/doc/cli/docs.md
@@ -0,0 +1,38 @@
+npm-docs(1) -- Docs for a package in a web browser maybe
+========================================================
+
+## SYNOPSIS
+
+ npm docs <pkgname>
+ npm home <pkgname>
+
+## DESCRIPTION
+
+This command tries to guess at the likely location of a package's
+documentation URL, and then tries to open it using the `--browser`
+config param.
+
+## CONFIGURATION
+
+### browser
+
+* Default: OS X: `"open"`, others: `"google-chrome"`
+* Type: String
+
+The browser that is called by the `npm docs` command to open websites.
+
+### registry
+
+* Default: https://registry.npmjs.org/
+* Type: url
+
+The base URL of the npm package registry.
+
+
+## SEE ALSO
+
+* npm-view(1)
+* npm-publish(1)
+* npm-registry(1)
+* npm-config(1)
+* npm-json(1)