mirror of https://github.com/nodejs/node.git synced 2025-05-15 14:41:29 +00:00

PR-URL: https://github.com/nodejs/node/pull/30533
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>

2019-11-20 19:16:47 -05:00

1.1 KiB

Raw Blame History

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

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.

1.1 KiB Raw Blame History