|
|
|
|
<!doctype html>
|
|
|
|
|
<html>
|
|
|
|
|
<title>npm-docs</title>
|
|
|
|
|
<meta http-equiv="content-type" value="text/html;utf-8">
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="../../static/style.css">
|
|
|
|
|
|
|
|
|
|
<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 (with no args in a package dir)
|
|
|
|
|
npm home [<pkgname> [<pkgname> ...]]
|
|
|
|
|
npm home (with no args in a package dir)</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: 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="../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>
|
|
|
|
|
<p id="footer">npm-docs — npm@1.3.25</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>
|
