|
|
- <!doctype html>
- <html>
- <title>npm-docs</title>
- <meta charset="utf-8">
- <link rel="stylesheet" type="text/css" href="../../static/style.css">
- <link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-docs.html">
- <script async=true src="../../static/toc.js"></script>
-
- <body>
- <div id="wrapper">
-
- <h1><a href="../cli/npm-docs.html">npm-docs</a></h1> <p>Docs for a package in a web browser maybe</p>
- <h2 id="synopsis">SYNOPSIS</h2>
- <pre><code>npm docs [<pkgname> [<pkgname> ...]]
- npm docs .
- npm home [<pkgname> [<pkgname> ...]]
- npm home .</code></pre><h2 id="description">DESCRIPTION</h2>
- <p>This command tries to guess at the likely location of a package's
- documentation URL, and then tries to open it using the <code>--browser</code>
- config param. You can pass multiple package names at once. If no
- package name is provided, it will search for a <code>package.json</code> in
- the current folder and use the <code>name</code> property.</p>
- <h2 id="configuration">CONFIGURATION</h2>
- <h3 id="browser">browser</h3>
- <ul>
- <li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li>
- <li>Type: String</li>
- </ul>
- <p>The browser that is called by the <code>npm docs</code> command to open websites.</p>
- <h3 id="registry">registry</h3>
- <ul>
- <li>Default: <a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a></li>
- <li>Type: url</li>
- </ul>
- <p>The base URL of the npm package registry.</p>
- <h2 id="see-also">SEE ALSO</h2>
- <ul>
- <li><a href="../cli/npm-view.html">npm-view(1)</a></li>
- <li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
- <li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
- <li><a href="../cli/npm-config.html">npm-config(1)</a></li>
- <li><a href="../misc/npm-config.html">npm-config(7)</a></li>
- <li><a href="../files/npmrc.html">npmrc(5)</a></li>
- <li><a href="../files/package.json.html">package.json(5)</a></li>
- </ul>
-
- </div>
-
- <table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
- <tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
- <tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
- <tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
- <tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
- <tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
- <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr>
- <tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr>
- </table>
- <p id="footer">npm-docs — npm@6.4.1</p>
-
|
