mirror of
https://github.com/nodejs/node.git
synced 2025-05-16 16:17:07 +00:00
aa0e4eb27f
PR-URL: https://github.com/nodejs/node/pull/38750 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Beth Griggs <bgriggs@redhat.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
227 lines
6.6 KiB
HTML
227 lines
6.6 KiB
HTML
<html><head>
|
||
<title>npm-docs</title>
|
||
<style>
|
||
body {
|
||
background-color: #ffffff;
|
||
color: #24292e;
|
||
|
||
margin: 0;
|
||
|
||
line-height: 1.5;
|
||
|
||
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
|
||
}
|
||
#rainbar {
|
||
height: 10px;
|
||
background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff);
|
||
}
|
||
|
||
a {
|
||
text-decoration: none;
|
||
color: #0366d6;
|
||
}
|
||
a:hover {
|
||
text-decoration: underline;
|
||
}
|
||
|
||
pre {
|
||
margin: 1em 0px;
|
||
padding: 1em;
|
||
border: solid 1px #e1e4e8;
|
||
border-radius: 6px;
|
||
|
||
display: block;
|
||
overflow: auto;
|
||
|
||
white-space: pre;
|
||
|
||
background-color: #f6f8fa;
|
||
color: #393a34;
|
||
}
|
||
code {
|
||
font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace;
|
||
font-size: 85%;
|
||
padding: 0.2em 0.4em;
|
||
background-color: #f6f8fa;
|
||
color: #393a34;
|
||
}
|
||
pre > code {
|
||
padding: 0;
|
||
background-color: inherit;
|
||
color: inherit;
|
||
}
|
||
h1, h2, h3 {
|
||
font-weight: 600;
|
||
}
|
||
|
||
#logobar {
|
||
background-color: #333333;
|
||
margin: 0 auto;
|
||
padding: 1em 4em;
|
||
}
|
||
#logobar .logo {
|
||
float: left;
|
||
}
|
||
#logobar .title {
|
||
font-weight: 600;
|
||
color: #dddddd;
|
||
float: left;
|
||
margin: 5px 0 0 1em;
|
||
}
|
||
#logobar:after {
|
||
content: "";
|
||
display: block;
|
||
clear: both;
|
||
}
|
||
|
||
#content {
|
||
margin: 0 auto;
|
||
padding: 0 4em;
|
||
}
|
||
|
||
#table_of_contents > h2 {
|
||
font-size: 1.17em;
|
||
}
|
||
#table_of_contents ul:first-child {
|
||
border: solid 1px #e1e4e8;
|
||
border-radius: 6px;
|
||
padding: 1em;
|
||
background-color: #f6f8fa;
|
||
color: #393a34;
|
||
}
|
||
#table_of_contents ul {
|
||
list-style-type: none;
|
||
padding-left: 1.5em;
|
||
}
|
||
#table_of_contents li {
|
||
font-size: 0.9em;
|
||
}
|
||
#table_of_contents li a {
|
||
color: #000000;
|
||
}
|
||
|
||
header.title {
|
||
border-bottom: solid 1px #e1e4e8;
|
||
}
|
||
header.title > h1 {
|
||
margin-bottom: 0.25em;
|
||
}
|
||
header.title > .description {
|
||
display: block;
|
||
margin-bottom: 0.5em;
|
||
line-height: 1;
|
||
}
|
||
|
||
footer#edit {
|
||
border-top: solid 1px #e1e4e8;
|
||
margin: 3em 0 4em 0;
|
||
padding-top: 2em;
|
||
}
|
||
</style>
|
||
</head>
|
||
<body>
|
||
<div id="banner">
|
||
<div id="rainbar"></div>
|
||
<div id="logobar">
|
||
<svg class="logo" role="img" height="32" width="32" viewBox="0 0 700 700">
|
||
<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon>
|
||
<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon>
|
||
</svg>
|
||
<div class="title">
|
||
npm command-line interface
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<section id="content">
|
||
<header class="title">
|
||
<h1 id="npm-docs">npm-docs</h1>
|
||
<span class="description">Open documentation for a package in a web browser</span>
|
||
</header>
|
||
|
||
<section id="table_of_contents">
|
||
<h2 id="table-of-contents">Table of contents</h2>
|
||
<div id="_table_of_contents"><ul><li><a href="#synopsis">Synopsis</a></li><li><a href="#description">Description</a></li><li><a href="#configuration">Configuration</a></li><ul><li><a href="#browser"><code>browser</code></a></li><li><a href="#registry"><code>registry</code></a></li><li><a href="#workspace"><code>workspace</code></a></li><li><a href="#workspaces"><code>workspaces</code></a></li></ul><li><a href="#see-also">See Also</a></li></ul></div>
|
||
</section>
|
||
|
||
<div id="_content"><h3 id="synopsis">Synopsis</h3>
|
||
<pre lang="bash"><code>npm docs [<pkgname> [<pkgname> ...]]
|
||
|
||
aliases: home
|
||
</code></pre>
|
||
<h3 id="description">Description</h3>
|
||
<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>
|
||
<h3 id="configuration">Configuration</h3>
|
||
<!-- raw HTML omitted -->
|
||
<!-- raw HTML omitted -->
|
||
<h4 id="browser"><code>browser</code></h4>
|
||
<ul>
|
||
<li>Default: OS X: <code>"open"</code>, Windows: <code>"start"</code>, Others: <code>"xdg-open"</code></li>
|
||
<li>Type: null, Boolean, or String</li>
|
||
</ul>
|
||
<p>The browser that is called by npm commands to open websites.</p>
|
||
<p>Set to <code>false</code> to suppress browser behavior and instead print urls to
|
||
terminal.</p>
|
||
<p>Set to <code>true</code> to use default system URL opener.</p>
|
||
<h4 id="registry"><code>registry</code></h4>
|
||
<ul>
|
||
<li>Default: “<a href="https://registry.npmjs.org/">https://registry.npmjs.org/</a>”</li>
|
||
<li>Type: URL</li>
|
||
</ul>
|
||
<p>The base URL of the npm registry.</p>
|
||
<h4 id="workspace"><code>workspace</code></h4>
|
||
<ul>
|
||
<li>Default:</li>
|
||
<li>Type: String (can be set multiple times)</li>
|
||
</ul>
|
||
<p>Enable running a command in the context of the configured workspaces of the
|
||
current project while filtering by running only the workspaces defined by
|
||
this configuration option.</p>
|
||
<p>Valid values for the <code>workspace</code> config are either:</p>
|
||
<ul>
|
||
<li>Workspace names</li>
|
||
<li>Path to a workspace directory</li>
|
||
<li>Path to a parent workspace directory (will result to selecting all of the
|
||
nested workspaces)</li>
|
||
</ul>
|
||
<p>When set for the <code>npm init</code> command, this may be set to the folder of a
|
||
workspace which does not yet exist, to create the folder and set it up as a
|
||
brand new workspace within the project.</p>
|
||
<p>This value is not exported to the environment for child processes.</p>
|
||
<h4 id="workspaces"><code>workspaces</code></h4>
|
||
<ul>
|
||
<li>Default: false</li>
|
||
<li>Type: Boolean</li>
|
||
</ul>
|
||
<p>Enable running a command in the context of <strong>all</strong> the configured
|
||
workspaces.</p>
|
||
<p>This value is not exported to the environment for child processes.</p>
|
||
<!-- raw HTML omitted -->
|
||
<h3 id="see-also">See Also</h3>
|
||
<ul>
|
||
<li><a href="../commands/npm-view.html">npm view</a></li>
|
||
<li><a href="../commands/npm-publish.html">npm publish</a></li>
|
||
<li><a href="../using-npm/registry.html">npm registry</a></li>
|
||
<li><a href="../commands/npm-config.html">npm config</a></li>
|
||
<li><a href="../configuring-npm/npmrc.html">npmrc</a></li>
|
||
<li><a href="../configuring-npm/package-json.html">package.json</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<footer id="edit">
|
||
<a href="https://github.com/npm/cli/edit/latest/docs/content/commands/npm-docs.md">
|
||
<svg role="img" viewBox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;">
|
||
<path fill-rule="evenodd" d="M11.013 1.427a1.75 1.75 0 012.474 0l1.086 1.086a1.75 1.75 0 010 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 01-.927-.928l.929-3.25a1.75 1.75 0 01.445-.758l8.61-8.61zm1.414 1.06a.25.25 0 00-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 000-.354l-1.086-1.086zM11.189 6.25L9.75 4.81l-6.286 6.287a.25.25 0 00-.064.108l-.558 1.953 1.953-.558a.249.249 0 00.108-.064l6.286-6.286z"></path>
|
||
</svg>
|
||
Edit this page on GitHub
|
||
</a>
|
||
</footer>
|
||
</section>
|
||
|
||
|
||
|
||
</body></html> |