1NPM-DOCS(1)                                                        NPM-DOCS(1)
2
3
4

NAME

6       npm-docs - Docs for a package in a web browser maybe
7
8   Synopsis
9         npm docs [<pkgname> [<pkgname> ...]]
10         npm docs .
11         npm home [<pkgname> [<pkgname> ...]]
12         npm home .
13
14   Description
15       This command tries to guess at the likely location of a package's docu‐
16       mentation URL, and then tries to open it  using  the  --browser  config
17       param.  You can pass multiple package names at once. If no package name
18       is provided, it will search for a package.json in  the  current  folder
19       and use the name property.
20
21   Configuration
22   browser
23       • Default: OS X: "open", Windows: "start", Others: "xdg-open"
24
25       • Type: String
26
27
28       The browser that is called by the npm docs command to open websites.
29
30   registry
31       • Default: https://registry.npmjs.org/
32
33       • Type: url
34
35
36       The base URL of the npm package registry.
37
38   See Also
39       • npm help view
40
41       • npm help publish
42
43       • npm help registry
44
45       • npm help config
46
47       • npm help npmrc
48
49       • npm help package.json
50
51
52
53
54                                  April 2021                       NPM-DOCS(1)
Impressum