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/api/npm-docs.html">
7 <script async=true src="../../static/toc.js"></script>
12 <h1><a href="../api/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.commands.docs(package, callback)
15 </code></pre><h2 id="description">DESCRIPTION</h2>
16 <p>This command tries to guess at the likely location of a package's
17 documentation URL, and then tries to open it using the <code>--browser</code>
19 <p>Like other commands, the first parameter is an array. This command only
20 uses the first element, which is expected to be a package name with an
21 optional version number.</p>
22 <p>This command will launch a browser, so this command may not be the most
23 friendly for programmatic use.</p>
27 <table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
28 <tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18> </td></tr>
29 <tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td><td style="width:40px;height:10px;background:#fff" colspan=4> </td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)"> </td><td colspan=6 style="width:60px;height:10px;background:#fff"> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4> </td></tr>
30 <tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2> </td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td><td style="width:10px;height:10px;background:#fff" rowspan=3> </td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3> </td></tr>
31 <tr><td style="width:10px;height:10px;background:#fff" rowspan=2> </td></tr>
32 <tr><td style="width:10px;height:10px;background:#fff"> </td></tr>
33 <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6> </td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)"> </td></tr>
34 <tr><td colspan=5 style="width:50px;height:10px;background:#fff"> </td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4> </td><td style="width:90px;height:10px;background:#fff" colspan=9> </td></tr>
36 <p id="footer">npm-docs — npm@2.14.4</p>