mirror of
https://github.com/zebrajr/node.git
synced 2025-12-06 12:20:27 +01:00
1b22f6049a
PR-URL: https://github.com/nodejs/node/pull/60168 Reviewed-By: Jordan Harband <ljharb@gmail.com> Reviewed-By: Chemi Atlow <chemi@atlow.co.il> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
109 lines
2.9 KiB
Markdown
109 lines
2.9 KiB
Markdown
---
|
|
title: npm-docs
|
|
section: 1
|
|
description: Open documentation for a package in a web browser
|
|
---
|
|
|
|
### Synopsis
|
|
|
|
```bash
|
|
npm docs [<pkgname> [<pkgname> ...]]
|
|
|
|
alias: 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](/using-npm/config#browser) 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: macOS: `"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.
|
|
|
|
|
|
|
|
#### `registry`
|
|
|
|
* Default: "https://registry.npmjs.org/"
|
|
* Type: URL
|
|
|
|
The base URL of the npm registry.
|
|
|
|
|
|
|
|
#### `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 in selecting all
|
|
workspaces within that folder)
|
|
|
|
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`
|
|
|
|
* Default: null
|
|
* Type: null or Boolean
|
|
|
|
Set to true to run the command in the context of **all** configured
|
|
workspaces.
|
|
|
|
Explicitly setting this to false will cause commands like `install`
|
|
to ignore workspaces altogether. When not set explicitly:
|
|
|
|
- Commands that operate on the `node_modules` tree (install, update,
|
|
etc.) will link workspaces into the `node_modules` folder. - Commands
|
|
that do other things (test, exec, publish, etc.) will operate on the
|
|
root project, _unless_ one or more workspaces are specified in the
|
|
`workspace` config.
|
|
|
|
This value is not exported to the environment for child processes.
|
|
|
|
#### `include-workspace-root`
|
|
|
|
* Default: false
|
|
* Type: Boolean
|
|
|
|
Include the workspace root when workspaces are enabled for a command.
|
|
|
|
When false, specifying individual workspaces via the `workspace`
|
|
config, or all workspaces via the `workspaces` flag, will cause npm
|
|
to operate only on the specified workspaces, and not on the root
|
|
project.
|
|
|
|
This value is not exported to the environment for child processes.
|
|
|
|
### 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)
|