aboutsummaryrefslogtreecommitdiff
path: root/deps/node/deps/npm/doc/cli/npm-docs.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/node/deps/npm/doc/cli/npm-docs.md')
-rw-r--r--deps/node/deps/npm/doc/cli/npm-docs.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/deps/node/deps/npm/doc/cli/npm-docs.md b/deps/node/deps/npm/doc/cli/npm-docs.md
new file mode 100644
index 00000000..f5064c55
--- /dev/null
+++ b/deps/node/deps/npm/doc/cli/npm-docs.md
@@ -0,0 +1,44 @@
+npm-docs(1) -- Docs for a package in a web browser maybe
+========================================================
+
+## SYNOPSIS
+
+ npm docs [<pkgname> [<pkgname> ...]]
+ npm docs .
+ npm home [<pkgname> [<pkgname> ...]]
+ npm home .
+
+## 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. You can pass multiple package names at once. If no
+package name is provided, it will search for a `package.json` in
+the current folder and use the `name` property.
+
+## CONFIGURATION
+
+### browser
+
+* Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
+* 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(7)
+* npm-config(1)
+* npm-config(7)
+* npmrc(5)
+* package.json(5)