npm-docs

Open documentation for a package in a web browser

Table of contents

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

The browser that is called by npm commands 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

The base URL of the npm registry.

workspace

Enable running a command in the context of the configured workspaces of the current project while filtering by running only the workspaces defined by this configuration option.

Valid values for the workspace config are either:

When set for the npm init command, this may be set to the folder of a workspace which does not yet exist, to create the folder and set it up as a brand new workspace within the project.

This value is not exported to the environment for child processes.

workspaces

Enable running a command in the context of all the configured workspaces.

This value is not exported to the environment for child processes.

See Also