"NPM-DOCS" "1" "April 2022" "" ""
"NAME"
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
\(bu 2
Default: OS X: "open", Windows: "start", Others: "xdg-open"
\(bu 2
Type: String
The browser that is called by the npm docs command to open websites\.
registry
\(bu 2
Default: https://registry\.npmjs\.org/
\(bu 2
Type: url
The base URL of the npm package registry\.
See Also
\(bu 2
npm help view
\(bu 2
npm help publish
\(bu 2
npm help registry
\(bu 2
npm help config
\(bu 2
npm help npmrc
\(bu 2
npm help package\.json