@cryptotaxi247 / documentation-1
Code Commits Issues Pulls Sessions CI/CD
dhei/classic-tokens
@reggi/path-to-regexp dependabot/npm_and_yarn/main/copy-to-clipboard-4.0.2 dependabot/npm_and_yarn/main/eslint-10.4.0 dependabot/npm_and_yarn/main/npmcli/eslint-config-7.0.0 dependabot/npm_and_yarn/main/proc-log-7.0.0 dependabot/npm_and_yarn/npm_and_yarn-826852524d dependabot/npm_and_yarn/npm_and_yarn-ab9a7f4bc2 deprecate-totp-2fa dhei/classic-tokens gat-bypass-2fa-docs jpg619/fix-accessibility-content-flow jpg619/version-bump-tar-2 kartykp/gat-bypass-2fa-docs kartykp/upgrade-path-to-regex main maitxn/version-bump-tar patch-1 reggi/cache-based-on-version reggi/dev-engines reggi/fix-transform-prettier reggi/overrides update-search-sensitivity
mdx 58 lines 1.57 KB
Raw
1 ---
2 title: npm-docs
3 section: 1
4 description: Docs for a package in a web browser maybe
5 github_repo: npm/cli
6 github_branch: release/v6
7 github_path: docs/content/commands/npm-docs.md
8 redirect_from:
9 - /cli-documentation/v6/cli-commands/docs
10 - /cli-documentation/v6/cli-commands/npm-docs
11 - /cli-documentation/v6/commands/docs
12 - /cli-documentation/v6/commands/npm-docs
13 - /cli-documentation/v6/docs
14 - /cli-documentation/v6/npm-docs
15 - /cli/v6/cli-commands/docs
16 - /cli/v6/cli-commands/npm-docs
17 - /cli/v6/commands/docs
18 - /cli/v6/docs
19 - /cli/v6/npm-docs
20 ---
21
22 ### Synopsis
23
24 ```bash
25 npm docs [<pkgname> [<pkgname> ...]]
26 npm docs .
27 npm home [<pkgname> [<pkgname> ...]]
28 npm home .
29 ```
30
31 ### Description
32
33 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.
34
35 ### Configuration
36
37 #### browser
38
39 - Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
40 - Type: String
41
42 The browser that is called by the `npm docs` command to open websites.
43
44 #### registry
45
46 - Default: https://registry.npmjs.org/
47 - Type: url
48
49 The base URL of the npm package registry.
50
51 ### See Also
52
53 - [npm view](/cli/v6/commands/npm-view)
54 - [npm publish](/cli/v6/commands/npm-publish)
55 - [npm registry](/cli/v6/using-npm/registry)
56 - [npm config](/cli/v6/commands/npm-config)
57 - [npmrc](/cli/v6/configuring-npm/npmrc)
58 - [package.json](/cli/v6/configuring-npm/package-json)