mirror of
https://github.com/nodejs/node.git
synced 2025-05-13 16:39:33 +00:00
248f4c3764
PR-URL: https://github.com/nodejs/node/pull/39813 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Rich Trott <rtrott@gmail.com>
101 lines
2.6 KiB
Markdown
101 lines
2.6 KiB
Markdown
---
|
|
title: npm-docs
|
|
section: 1
|
|
description: Open documentation for a package in a web browser
|
|
---
|
|
|
|
### Synopsis
|
|
|
|
```bash
|
|
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
|
|
|
|
<!-- AUTOGENERATED CONFIG DESCRIPTIONS START -->
|
|
<!-- automatically generated, do not edit manually -->
|
|
<!-- see lib/utils/config/definitions.js -->
|
|
#### `browser`
|
|
|
|
* Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
|
|
* Type: null, Boolean, or String
|
|
|
|
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.
|
|
|
|
<!-- automatically generated, do not edit manually -->
|
|
<!-- see lib/utils/config/definitions.js -->
|
|
|
|
#### `registry`
|
|
|
|
* Default: "https://registry.npmjs.org/"
|
|
* Type: URL
|
|
|
|
The base URL of the npm registry.
|
|
|
|
<!-- automatically generated, do not edit manually -->
|
|
<!-- see lib/utils/config/definitions.js -->
|
|
|
|
#### `workspace`
|
|
|
|
* Default:
|
|
* Type: String (can be set multiple times)
|
|
|
|
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:
|
|
|
|
* Workspace names
|
|
* Path to a workspace directory
|
|
* Path to a parent workspace directory (will result to selecting all of the
|
|
nested workspaces)
|
|
|
|
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.
|
|
|
|
<!-- automatically generated, do not edit manually -->
|
|
<!-- see lib/utils/config/definitions.js -->
|
|
|
|
#### `workspaces`
|
|
|
|
* Default: false
|
|
* Type: Boolean
|
|
|
|
Enable running a command in the context of **all** the configured
|
|
workspaces.
|
|
|
|
This value is not exported to the environment for child processes.
|
|
|
|
<!-- automatically generated, do not edit manually -->
|
|
<!-- see lib/utils/config/definitions.js -->
|
|
|
|
<!-- AUTOGENERATED CONFIG DESCRIPTIONS END -->
|
|
|
|
### See Also
|
|
|
|
* [npm view](/commands/npm-view)
|
|
* [npm publish](/commands/npm-publish)
|
|
* [npm registry](/using-npm/registry)
|
|
* [npm config](/commands/npm-config)
|
|
* [npmrc](/configuring-npm/npmrc)
|
|
* [package.json](/configuring-npm/package-json)
|