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
   7   <body>
   8     <div id="wrapper">
   9 <h1><a href="../cli/npm-docs.html">npm-docs</a></h1> <p>Docs for a package in a web browser maybe</p>
  10
  11 <h2 id="SYNOPSIS">SYNOPSIS</h2>
  12
  13 <pre><code>npm docs &lt;pkgname&gt;
  14 npm home &lt;pkgname&gt;</code></pre>
  15
  16 <h2 id="DESCRIPTION">DESCRIPTION</h2>
  17
  18 <p>This command tries to guess at the likely location of a package&#39;s
  19 documentation URL, and then tries to open it using the <code>--browser</code>
  20 config param.</p>
  21
  22 <h2 id="CONFIGURATION">CONFIGURATION</h2>
  23
  24 <h3 id="browser">browser</h3>
  25
  26 <ul><li>Default: OS X: <code>&quot;open&quot;</code>, Windows: <code>&quot;start&quot;</code>, Others: <code>&quot;xdg-open&quot;</code></li><li>Type: String</li></ul>
  27
  28 <p>The browser that is called by the <code>npm docs</code> command to open websites.</p>
  29
  30 <h3 id="registry">registry</h3>
  31
  32 <ul><li>Default: https://registry.npmjs.org/</li><li>Type: url</li></ul>
  33
  34 <p>The base URL of the npm package registry.</p>
  35
  36 <h2 id="SEE-ALSO">SEE ALSO</h2>
  37
  38 <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>
  39 </div>
  40 <p id="footer">npm-docs &mdash; npm@1.3.17</p>
  41 <script>
  42 ;(function () {
  43 var wrapper = document.getElementById("wrapper")
  44 var els = Array.prototype.slice.call(wrapper.getElementsByTagName("*"), 0)
  45   .filter(function (el) {
  46     return el.parentNode === wrapper
  47         && el.tagName.match(/H[1-6]/)
  48         && el.id
  49   })
  50 var l = 2
  51   , toc = document.createElement("ul")
  52 toc.innerHTML = els.map(function (el) {
  53   var i = el.tagName.charAt(1)
  54     , out = ""
  55   while (i > l) {
  56     out += "<ul>"
  57     l ++
  58   }
  59   while (i < l) {
  60     out += "</ul>"
  61     l --
  62   }
  63   out += "<li><a href='#" + el.id + "'>" +
  64     ( el.innerText || el.text || el.innerHTML)
  65     + "</a>"
  66   return out
  67 }).join("\n")
  68 toc.id = "toc"
  69 document.body.appendChild(toc)
  70 })()
  71 </script>