SYNOPSIS

npm docs [<pkgname> [<pkgname> ...]]
npm docs (with no args in a package dir)
npm home [<pkgname> [<pkgname> ...]]
npm home (with no args in a package dir)

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.

RELATED TO npm-docs…

*

npm help view

*

npm help publish

*

npm help registry

*

npm help config

*

npm help config

*

npm help npmrc

*

npm help package.json