deps/npm/html/doc/cli/npm-docs.html

   1 <!doctype html>
   2 <html>
   3   <title>npm-docs</title>
   4   <meta http-equiv="content-type" value="text/html;utf-8">
   5   <link rel="stylesheet" type="text/css" href="../../static/style.css">
   6   <link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-docs.html">
   7   <script async=true src="../../static/toc.js"></script>
   8
   9   <body>
  10     <div id="wrapper">
  11
  12 <h1><a href="../cli/npm-docs.html">npm-docs</a></h1> <p>Docs for a package in a web browser maybe</p>
  13 <h2 id="synopsis">SYNOPSIS</h2>
  14 <pre><code>npm docs [&lt;pkgname&gt; [&lt;pkgname&gt; ...]]
  15 npm docs (with no args in a package dir)
  16 npm home [&lt;pkgname&gt; [&lt;pkgname&gt; ...]]
  17 npm home (with no args in a package dir)
  18 </code></pre><h2 id="description">DESCRIPTION</h2>
  19 <p>This command tries to guess at the likely location of a package&#39;s
  20 documentation URL, and then tries to open it using the <code>--browser</code>
  21 config param. You can pass multiple package names at once. If no
  22 package name is provided, it will search for a <code>package.json</code> in
  23 the current folder and use the <code>name</code> property.</p>
  24 <h2 id="configuration">CONFIGURATION</h2>
  25 <h3 id="browser">browser</h3>
  26 <ul>
  27 <li>Default: OS X: <code>&quot;open&quot;</code>, Windows: <code>&quot;start&quot;</code>, Others: <code>&quot;xdg-open&quot;</code></li>
  28 <li>Type: String</li>
  29 </ul>
  30 <p>The browser that is called by the <code>npm docs</code> command to open websites.</p>
  31 <h3 id="registry">registry</h3>
  32 <ul>
  33 <li>Default: <a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a></li>
  34 <li>Type: url</li>
  35 </ul>
  36 <p>The base URL of the npm package registry.</p>
  37 <h2 id="see-also">SEE ALSO</h2>
  38 <ul>
  39 <li><a href="../cli/npm-view.html">npm-view(1)</a></li>
  40 <li><a href="../cli/npm-publish.html">npm-publish(1)</a></li>
  41 <li><a href="../misc/npm-registry.html">npm-registry(7)</a></li>
  42 <li><a href="../cli/npm-config.html">npm-config(1)</a></li>
  43 <li><a href="../misc/npm-config.html">npm-config(7)</a></li>
  44 <li><a href="../files/npmrc.html">npmrc(5)</a></li>
  45 <li><a href="../files/package.json.html">package.json(5)</a></li>
  46 </ul>
  47
  48 </div>
  49
  50 <table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
  51 <tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18>&nbsp;</td></tr>
  52 <tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td><td style="width:40px;height:10px;background:#fff" colspan=4>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4>&nbsp;</td><td style="width:40px;height:10px;background:#fff" colspan=4>&nbsp;</td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td><td colspan=6 style="width:60px;height:10px;background:#fff">&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4>&nbsp;</td></tr>
  53 <tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2>&nbsp;</td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td></tr>
  54 <tr><td style="width:10px;height:10px;background:#fff" rowspan=2>&nbsp;</td></tr>
  55 <tr><td style="width:10px;height:10px;background:#fff">&nbsp;</td></tr>
  56 <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6>&nbsp;</td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td></tr>
  57 <tr><td colspan=5 style="width:50px;height:10px;background:#fff">&nbsp;</td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4>&nbsp;</td><td style="width:90px;height:10px;background:#fff" colspan=9>&nbsp;</td></tr>
  58 </table>
  59 <p id="footer">npm-docs &mdash; npm@2.14.4</p>
  60