mirror of https://github.com/nodejs/node.git synced 2025-05-15 22:04:26 +00:00

PR-URL: https://github.com/nodejs/node/pull/35474
Reviewed-By: Ruy Adorno <ruyadorno@github.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Ben Coe <bencoe@gmail.com>
Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>

2020-10-07 09:59:49 -04:00

1.2 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> ...]]

aliases: 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 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/
Type: url

The base URL of the npm package registry.

1.2 KiB Raw Blame History