deps/npm/html/doc/api/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="../api/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.commands.docs(package, callback)</code></pre>
  14
  15 <h2 id="DESCRIPTION">DESCRIPTION</h2>
  16
  17 <p>This command tries to guess at the likely location of a package&#39;s
  18 documentation URL, and then tries to open it using the <code>--browser</code>
  19 config param.</p>
  20
  21 <p>Like other commands, the first parameter is an array. This command only
  22 uses the first element, which is expected to be a package name with an
  23 optional version number.</p>
  24
  25 <p>This command will launch a browser, so this command may not be the most
  26 friendly for programmatic use.</p>
  27 </div>
  28 <p id="footer">npm-docs &mdash; npm@1.3.15</p>
  29 <script>
  30 ;(function () {
  31 var wrapper = document.getElementById("wrapper")
  32 var els = Array.prototype.slice.call(wrapper.getElementsByTagName("*"), 0)
  33   .filter(function (el) {
  34     return el.parentNode === wrapper
  35         && el.tagName.match(/H[1-6]/)
  36         && el.id
  37   })
  38 var l = 2
  39   , toc = document.createElement("ul")
  40 toc.innerHTML = els.map(function (el) {
  41   var i = el.tagName.charAt(1)
  42     , out = ""
  43   while (i > l) {
  44     out += "<ul>"
  45     l ++
  46   }
  47   while (i < l) {
  48     out += "</ul>"
  49     l --
  50   }
  51   out += "<li><a href='#" + el.id + "'>" +
  52     ( el.innerText || el.text || el.innerHTML)
  53     + "</a>"
  54   return out
  55 }).join("\n")
  56 toc.id = "toc"
  57 document.body.appendChild(toc)
  58 })()
  59 </script>