diff options
author | isaacs <i@izs.me> | 2011-09-09 00:36:41 +0400 |
---|---|---|
committer | isaacs <i@izs.me> | 2011-09-09 00:36:41 +0400 |
commit | 8e08f0d8d6e1f70eaa2358c8ee211e2cfe59192c (patch) | |
tree | 9e3dba74c09e9646798723e86307f26acb1c0e7b /html | |
parent | 4dc1095d7e7358fb50cadbe670cfd4946cba5f88 (diff) |
Remove some contrived SYNOPSISes, and just use the heading
Diffstat (limited to 'html')
-rw-r--r-- | html/doc/changelog.html | 4 | ||||
-rw-r--r-- | html/doc/faq.html | 4 | ||||
-rw-r--r-- | html/doc/index.html | 139 |
3 files changed, 51 insertions, 96 deletions
diff --git a/html/doc/changelog.html b/html/doc/changelog.html index 999083d3e..902328bd7 100644 --- a/html/doc/changelog.html +++ b/html/doc/changelog.html @@ -8,10 +8,6 @@ <div id="wrapper"> <h1><a href="changelog.html">changelog</a></h1> <p>Changes</p> -<h2 id="SYNOPSIS">SYNOPSIS</h2> - -<p>A brief history.</p> - <h2 id="HISTORY">HISTORY</h2> <h3 id="1-0">1.0</h3> diff --git a/html/doc/faq.html b/html/doc/faq.html index 84df29f4c..d561881e0 100644 --- a/html/doc/faq.html +++ b/html/doc/faq.html @@ -8,10 +8,6 @@ <div id="wrapper"> <h1><a href="faq.html">faq</a></h1> <p>Frequently Asked Questions</p> -<h2 id="SYNOPSIS">SYNOPSIS</h2> - -<p>Questions asked frequently.</p> - <h2 id="Where-can-I-find-these-docs-in-HTML">Where can I find these docs in HTML?</h2> <p><a href="http://npmjs.org/doc/">http://npmjs.org/doc/</a>, or run:</p> diff --git a/html/doc/index.html b/html/doc/index.html index d98f1049b..fcc0a6e1c 100644 --- a/html/doc/index.html +++ b/html/doc/index.html @@ -10,244 +10,207 @@ <h2 id="npm-README-1"><a href="README.html">README</a></h2> -<p>This is just enough info to get you up and running.</p> +<p> node package manager</p> <h2 id="npm-adduser-1"><a href="adduser.html">adduser</a></h2> -<p>Create or verify a user named <code><username></code> in the npm registry, and -save the credentials to the <code>.npmrc</code> file.</p> +<p> Add a registry user account</p> <h2 id="npm-bin-1"><a href="bin.html">bin</a></h2> -<p>Print the folder where npm will install executables.</p> +<p> Display npm bin folder</p> <h2 id="npm-build-1"><a href="build.html">build</a></h2> -<p>This is the plumbing command called by <code>npm link</code> and <code>npm install</code>.</p> +<p> Build a package</p> <h2 id="npm-bundle-1"><a href="bundle.html">bundle</a></h2> -<p>The <code>npm bundle</code> command has been removed in 1.0, for the simple reason -that it is no longer necessary, as the default behavior is now to -install packages into the local space.</p> +<p> REMOVED</p> <h2 id="npm-cache-1"><a href="cache.html">cache</a></h2> -<p>Used to add, list, or clear the npm cache folder.</p> +<p> install a package</p> <h2 id="npm-changelog-1"><a href="changelog.html">changelog</a></h2> -<p>A brief history.</p> +<p> Changes</p> <h2 id="npm-coding-style-1"><a href="coding-style.html">coding-style</a></h2> -<p>npm's coding style is a bit unconventional. It is not different for -difference's sake, but rather a carefully crafted style that is -designed to reduce visual clutter and make bugs more apparent.</p> +<p> npm's "funny" coding style</p> <h2 id="npm-completion-1"><a href="completion.html">completion</a></h2> -<p>Enables tab-completion in all npm commands.</p> +<p> Tab Completion for npm</p> <h2 id="npm-config-1"><a href="config.html">config</a></h2> -<p>npm gets its configuration values from 5 sources, in this priority:</p> +<p> Manage the npm configuration file</p> <h2 id="npm-deprecate-1"><a href="deprecate.html">deprecate</a></h2> -<p>This command will update the npm registry entry for a package, providing -a deprecation warning to all who attempt to install it.</p> +<p> Deprecate a version of a package</p> <h2 id="npm-developers-1"><a href="developers.html">developers</a></h2> -<p>So, you've decided to use npm to develop (and maybe publish/deploy) -your project.</p> +<p> Developer Guide</p> <h2 id="npm-docs-1"><a href="docs.html">docs</a></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> +<p> Docs for a package in a web browser maybe</p> <h2 id="npm-edit-1"><a href="edit.html">edit</a></h2> -<p>Opens the package folder in the default editor (or whatever you've -configured as the npm <code>editor</code> config -- see <code><a href="config.html">config</a></code>.)</p> +<p> Edit an installed package</p> <h2 id="npm-explore-1"><a href="explore.html">explore</a></h2> -<p>Spawn a subshell in the directory of the installed package specified.</p> +<p> Browse an installed package</p> <h2 id="npm-faq-1"><a href="faq.html">faq</a></h2> -<p>Questions asked frequently.</p> +<p> Frequently Asked Questions</p> <h2 id="npm-folders-1"><a href="folders.html">folders</a></h2> -<p>npm puts various things on your computer. That's its job.</p> +<p> Folder Structures Used by npm</p> <h2 id="npm-help-search-1"><a href="help-search.html">help-search</a></h2> -<p>This command will search the npm markdown documentation files for the -terms provided, and then list the results, sorted by relevance.</p> +<p> Search npm help documentation</p> <h2 id="npm-help-1"><a href="help.html">help</a></h2> -<p>If supplied a topic, then show the appropriate documentation page.</p> +<p> Get help on npm</p> <h2 id="npm-init-1"><a href="init.html">init</a></h2> -<p>This will ask you a bunch of questions, and then write a package.json for you.</p> +<p> Interactively create a package.json file</p> <h2 id="npm-install-1"><a href="install.html">install</a></h2> -<p>This command installs a package, and any packages that it depends on.</p> +<p> install a package</p> <h2 id="npm-json-1"><a href="json.html">json</a></h2> -<p>This document is all you need to know about what's required in your package.json -file. It must be actual JSON, not just a JavaScript object literal.</p> +<p> Specifics of npm's package.json handling</p> <h2 id="npm-link-1"><a href="link.html">link</a></h2> -<p>Package linking is a two-step process.</p> +<p> Symlink a package folder</p> <h2 id="npm-list-1"><a href="list.html">list</a></h2> -<p>This command will print to stdout all the versions of packages that are -installed, as well as their dependencies, in a tree-structure.</p> +<p> List installed packages</p> <h2 id="npm-1"><a href="npm.html">npm</a></h2> -<p>npm is the package manager for the Node JavaScript platform. It puts -modules in place so that node can find them, and manages dependency -conflicts intelligently.</p> +<p> node package manager</p> <h2 id="npm-outdated-1"><a href="outdated.html">outdated</a></h2> -<p>This command will check the registry to see if any (or, specific) installed -packages are currently outdated.</p> +<p> Check for outdated packages</p> <h2 id="npm-owner-1"><a href="owner.html">owner</a></h2> -<p>Manage ownership of published packages.</p> +<p> Manage package owners</p> <h2 id="npm-pack-1"><a href="pack.html">pack</a></h2> -<p>For anything that's installable (that is, a package folder, tarball, -tarball url, name@tag, name@version, or name), this command will fetch -it to the cache, and then copy the tarball to the current working -directory as <code><name>-<version>.tgz</code>, and then write the filenames out to -stdout.</p> +<p> Create a tarball from a package</p> <h2 id="npm-prefix-1"><a href="prefix.html">prefix</a></h2> -<p>Print the prefix to standard out.</p> +<p> Display prefix</p> <h2 id="npm-prune-1"><a href="prune.html">prune</a></h2> -<p>This command removes "extraneous" packages. If a package name is -provided, then only packages matching one of the supplied names are -removed.</p> +<p> Remove extraneous packages</p> <h2 id="npm-publish-1"><a href="publish.html">publish</a></h2> -<p>Publishes a package to the registry so that it can be installed by name.</p> +<p> Publish a package</p> <h2 id="npm-rebuild-1"><a href="rebuild.html">rebuild</a></h2> -<p>This command runs the <code>npm build</code> command on the matched folders. This is useful -when you install a new version of node, and must recompile all your C++ addons with -the new binary.</p> +<p> Rebuild a package</p> <h2 id="npm-registry-1"><a href="registry.html">registry</a></h2> -<p>To resolve packages by name and version, npm talks to a registry website -that implements the CommonJS Package Registry specification for reading -package info.</p> +<p> The JavaScript Package Registry</p> <h2 id="npm-removing-npm-1"><a href="removing-npm.html">removing-npm</a></h2> -<p>So sad to see you go.</p> +<p> Cleaning the Slate</p> <h2 id="npm-restart-1"><a href="restart.html">restart</a></h2> -<p>This runs a package's "restart" script, if one was provided. -Otherwise it runs package's "stop" script, if one was provided, and then -the "start" script.</p> +<p> Start a package</p> <h2 id="npm-root-1"><a href="root.html">root</a></h2> -<p>Print the effective <code>node_modules</code> folder to standard out.</p> +<p> Display npm root</p> <h2 id="npm-run-script-1"><a href="run-script.html">run-script</a></h2> -<p>This runs an arbitrary command from a package's "scripts" object.</p> +<p> Run arbitrary package scripts</p> <h2 id="npm-scripts-1"><a href="scripts.html">scripts</a></h2> -<p>npm supports the "scripts" member of the package.json script, for the -following scripts:</p> +<p> How npm handles the "scripts" field</p> <h2 id="npm-search-1"><a href="search.html">search</a></h2> -<p>Search the registry for packages matching the search terms.</p> +<p> Search for packages</p> <h2 id="npm-semver-1"><a href="semver.html">semver</a></h2> -<p>As a node module:</p> +<p> The semantic versioner for npm</p> <h2 id="npm-start-1"><a href="start.html">start</a></h2> -<p>This runs a package's "start" script, if one was provided.</p> +<p> Start a package</p> <h2 id="npm-stop-1"><a href="stop.html">stop</a></h2> -<p>This runs a package's "stop" script, if one was provided.</p> +<p> Stop a package</p> <h2 id="npm-submodule-1"><a href="submodule.html">submodule</a></h2> -<p>If the specified package has a git repository url in its package.json -description, then this command will add it as a git submodule at -<code>node_modules/<pkg name></code>.</p> +<p> Add a package as a git submodule</p> <h2 id="npm-tag-1"><a href="tag.html">tag</a></h2> -<p>Tags the specified version of the package with the specified tag, or the -<code>--tag</code> config if not specified.</p> +<p> Tag a published version</p> <h2 id="npm-test-1"><a href="test.html">test</a></h2> -<p>This runs a package's "test" script, if one was provided.</p> +<p> Test a package</p> <h2 id="npm-uninstall-1"><a href="uninstall.html">uninstall</a></h2> -<p>This uninstalls a package, completely removing everything npm installed -on its behalf.</p> +<p> Remove a package</p> <h2 id="npm-unpublish-1"><a href="unpublish.html">unpublish</a></h2> -<p>This removes a package version from the registry, deleting its -entry and removing the tarball.</p> +<p> Remove a package from the registry</p> <h2 id="npm-update-1"><a href="update.html">update</a></h2> -<p>This command will update all the packages listed to the latest version -(specified by the <code>tag</code> config).</p> +<p> Update a package</p> <h2 id="npm-version-1"><a href="version.html">version</a></h2> -<p>Run this in a package directory to bump the version and write the new -data back to the package.json file.</p> +<p> Bump a package version</p> <h2 id="npm-view-1"><a href="view.html">view</a></h2> -<p>This command shows data about a package and prints it to the stream -referenced by the <code>outfd</code> config, which defaults to stdout.</p> +<p> View registry info</p> <h2 id="npm-whoami-1"><a href="whoami.html">whoami</a></h2> -<p>Print the <code>username</code> config to standard output.</p> +<p> Display npm username</p> </div> <p id="footer">index — npm@1.0.28-pre-DEV-UNSTABLE</p> <script> |