node/deps/npm/docs/content/cli-commands/npm-docs.md
Ruy Adorno 4b97c3addb deps: update npm to 6.13.0
PR-URL: https://github.com/nodejs/node/pull/30271
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-11-09 20:13:43 -08:00

1.1 KiB
Executable File

section title description
cli-commands npm-docs Docs for a package in a web browser maybe

npm-docs

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

The base URL of the npm package registry.

See Also