<!doctype html> <html> <title>docs</title> <meta http-equiv="content-type" value="text/html;utf-8"> <link rel="stylesheet" type="text/css" href="../style.css"> <body> <div id="wrapper"> <h1><a href="../doc/docs.html">docs</a></h1> <p>Docs for a package in a web browser maybe</p> <h2 id="SYNOPSIS">SYNOPSIS</h2> <pre><code>npm docs <pkgname> npm home <pkgname></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.</p> <h2 id="CONFIGURATION">CONFIGURATION</h2> <h3 id="browser">browser</h3> <ul><li>Default: OS X: <code>"open"</code>, others: <code>"google-chrome"</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: https://registry.npmjs.org/</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="../doc/view.html">view(1)</a></li><li><a href="../doc/publish.html">publish(1)</a></li><li><a href="../doc/registry.html">registry(1)</a></li><li><a href="../doc/config.html">config(1)</a></li><li><a href="../doc/json.html">json(1)</a></li></ul> </div> <p id="footer">docs — npm@1.1.43</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") var els = Array.prototype.slice.call(wrapper.getElementsByTagName("*"), 0) .filter(function (el) { return el.parentNode === wrapper && el.tagName.match(/H[1-6]/) && el.id }) var l = 2 , toc = document.createElement("ul") toc.innerHTML = els.map(function (el) { var i = el.tagName.charAt(1) , out = "" while (i > l) { out += "<ul>" l ++ } while (i < l) { out += "</ul>" l -- } out += "<li><a href='#" + el.id + "'>" + ( el.innerText || el.text || el.innerHTML) + "</a>" return out }).join("\n") toc.id = "toc" document.body.appendChild(toc) })() </script> </body></html>