Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/cli-commands/npm-docs.md')
-rw-r--r--docs/content/cli-commands/npm-docs.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/docs/content/cli-commands/npm-docs.md b/docs/content/cli-commands/npm-docs.md
index f157e200d..ffa5db5ac 100644
--- a/docs/content/cli-commands/npm-docs.md
+++ b/docs/content/cli-commands/npm-docs.md
@@ -12,9 +12,8 @@ description: Docs for a package in a web browser maybe
```bash
npm docs [<pkgname> [<pkgname> ...]]
-npm docs .
-npm home [<pkgname> [<pkgname> ...]]
-npm home .
+
+aliases: home
```
### Description
@@ -30,10 +29,15 @@ the current folder and use the `name` property.
#### browser
* Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
-* Type: String
+* Type: String or Boolean
The browser that is called by the `npm docs` command to open websites.
+Set to `false` to suppress browser behavior and instead print urls to
+terminal.
+
+Set to `true` to use default system URL opener.
+
#### registry
* Default: https://registry.npmjs.org/