Permalink
Browse files

make doc

  • Loading branch information...
isaacs committed Sep 8, 2011
1 parent 55d2677 commit d5a920f7988e5091de1b87aba3ead7bd8e591f8a
Showing with 406 additions and 234 deletions.
  1. +2 −0 doc/cache.md
  2. +4 −0 doc/changelog.md
  3. +3 −1 doc/completion.md
  4. +4 −0 doc/faq.md
  5. +0 −1 doc/link.md
  6. +2 −0 doc/owner.md
  7. +1 −1 doc/removing-npm.md
  8. +5 −1 doc/semver.md
  9. +4 −2 html/doc/README.html
  10. +5 −3 html/doc/adduser.html
  11. +7 −3 html/doc/author.html
  12. +5 −3 html/doc/bin.html
  13. +5 −3 html/doc/build.html
  14. +5 −3 html/doc/bundle.html
  15. +7 −3 html/doc/cache.html
  16. +9 −3 html/doc/changelog.html
  17. +6 −4 html/doc/coding-style.html
  18. +8 −4 html/doc/completion.html
  19. +9 −7 html/doc/config.html
  20. +5 −3 html/doc/deprecate.html
  21. +10 −8 html/doc/developers.html
  22. +5 −3 html/doc/docs.html
  23. +6 −4 html/doc/edit.html
  24. +5 −3 html/doc/explore.html
  25. +15 −9 html/doc/faq.html
  26. +7 −5 html/doc/folders.html
  27. +9 −7 html/doc/get.html
  28. +7 −5 html/doc/global.html
  29. +5 −3 html/doc/help-search.html
  30. +5 −3 html/doc/help.html
  31. +5 −3 html/doc/home.html
  32. +5 −3 html/doc/init.html
  33. +9 −7 html/doc/install.html
  34. +10 −8 html/doc/json.html
  35. +5 −3 html/doc/link.html
  36. +5 −3 html/doc/list.html
  37. +5 −3 html/doc/ln.html
  38. +5 −3 html/doc/ls.html
  39. +10 −8 html/doc/npm.html
  40. +5 −3 html/doc/outdated.html
  41. +7 −3 html/doc/owner.html
  42. +5 −3 html/doc/pack.html
  43. +5 −3 html/doc/prefix.html
  44. +5 −3 html/doc/prune.html
  45. +5 −3 html/doc/publish.html
  46. +5 −3 html/doc/rebuild.html
  47. +7 −5 html/doc/registry.html
  48. +6 −4 html/doc/removing-npm.html
  49. +5 −3 html/doc/restart.html
  50. +5 −3 html/doc/rm.html
  51. +5 −3 html/doc/root.html
  52. +5 −3 html/doc/run-script.html
  53. +6 −4 html/doc/scripts.html
  54. +5 −3 html/doc/search.html
  55. +10 −4 html/doc/semver.html
  56. +9 −7 html/doc/set.html
  57. +5 −3 html/doc/start.html
  58. +5 −3 html/doc/stop.html
  59. +5 −3 html/doc/submodule.html
  60. +5 −3 html/doc/tag.html
  61. +5 −3 html/doc/test.html
  62. +5 −3 html/doc/uninstall.html
  63. +5 −3 html/doc/unpublish.html
  64. +5 −3 html/doc/update.html
  65. +5 −3 html/doc/version.html
  66. +6 −4 html/doc/view.html
  67. +5 −3 html/doc/whoami.html
  68. +3 −1 html/docfoot.html
  69. +1 −0 man1/author.1
  70. +1 −0 man1/cache.1
  71. +3 −0 man1/changelog.1
  72. +4 −1 man1/completion.1
  73. +3 −0 man1/faq.1
  74. +1 −0 man1/owner.1
  75. +1 −1 man1/removing-npm.1
  76. +4 −1 man1/semver.1
View
@@ -14,6 +14,8 @@ npm-cache(1) -- install a package
## DESCRIPTION
+Used to add, list, or clear the npm cache folder.
+
* add:
Add the specified package to the local cache. This command is primarily
intended to be used internally by npm, but it can provide a way to
View
@@ -1,6 +1,10 @@
npm-changelog(1) -- Changes
===========================
+## SYNOPSIS
+
+A brief history.
+
## HISTORY
### 1.0
View
@@ -7,7 +7,9 @@ npm-completion(1) -- Tab Completion for npm
## DESCRIPTION
-Enables tab-completion in all npm commands. The synopsis above
+Enables tab-completion in all npm commands.
+
+The synopsis above
loads the completions into your current shell. Adding it to
your ~/.bashrc or ~/.zshrc will make the completions available
everywhere.
View
@@ -1,6 +1,10 @@
npm-faq(1) -- Frequently Asked Questions
========================================
+## SYNOPSIS
+
+Questions asked frequently.
+
## Where can I find these docs in HTML?
<http://npmjs.org/doc/>, or run:
View
@@ -6,7 +6,6 @@ npm-link(1) -- Symlink a package folder
npm link (in package folder)
npm link <pkgname>
-
## DESCRIPTION
Package linking is a two-step process.
View
@@ -9,6 +9,8 @@ npm-owner(1) -- Manage package owners
## DESCRIPTION
+Manage ownership of published packages.
+
* ls:
List all the users who have access to modify a package and push new versions.
Handy when you need to know who to bug for help.
View
@@ -1,7 +1,7 @@
npm-removal(1) -- Cleaning the Slate
====================================
-## SUMMARY
+## SYNOPSIS
So sad to see you go.
View
@@ -1,7 +1,11 @@
npm-semver(1) -- The semantic versioner for npm
===============================================
-## Usage
+## SYNOPSIS
+
+The npm semantic versioning utility.
+
+## DESCRIPTION
As a node module:
View
@@ -209,7 +209,7 @@ <h3 id="In-plain-english">In plain english</h3>
<h2 id="SEE-ALSO">SEE ALSO</h2>
-<ul><li><a href="npm.html">npm</a></li><li><a href="faq.html">npm faq</a></li><li><a href="help.html">npm help</a></li></ul>
+<ul><li><a href="npm.html">npm</a></li><li><a href="faq.html">faq</a></li><li><a href="help.html">help</a></li></ul>
</div>
<p id="footer"><a href="README.html">README</a> &mdash; npm@1.0.28-pre-DEV-UNSTABLE</p>
<script>
@@ -234,7 +234,9 @@ <h2 id="SEE-ALSO">SEE ALSO</h2>
out += "</ul>"
l --
}
- out += "<li><a href='#" + el.id + "'>" + el.innerHTML + "</a>"
+ out += "<li><a href='#" + el.id + "'>" +
+ ( el.innerText || el.text || el.innerHTML)
+ + "</a>"
return out
}).join("\n")
toc.id = "toc"
View
@@ -6,7 +6,7 @@
<body>
<div id="wrapper">
-<h1><a href="adduser.html">npm adduser</a></h1> <p>Add a registry user account</p>
+<h1><a href="adduser.html">adduser</a></h1> <p>Add a registry user account</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
@@ -37,7 +37,7 @@ <h3 id="registry">registry</h3>
<h2 id="SEE-ALSO">SEE ALSO</h2>
-<ul><li><a href="registry.html">npm registry</a></li><li><a href="config.html">npm config</a></li><li><a href="owner.html">npm owner</a></li><li><a href="whoami.html">npm whoami</a></li></ul>
+<ul><li><a href="registry.html">registry</a></li><li><a href="config.html">config</a></li><li><a href="owner.html">owner</a></li><li><a href="whoami.html">whoami</a></li></ul>
</div>
<p id="footer">adduser &mdash; npm@1.0.28-pre-DEV-UNSTABLE</p>
<script>
@@ -62,7 +62,9 @@ <h2 id="SEE-ALSO">SEE ALSO</h2>
out += "</ul>"
l --
}
- out += "<li><a href='#" + el.id + "'>" + el.innerHTML + "</a>"
+ out += "<li><a href='#" + el.id + "'>" +
+ ( el.innerText || el.text || el.innerHTML)
+ + "</a>"
return out
}).join("\n")
toc.id = "toc"
View
@@ -6,7 +6,7 @@
<body>
<div id="wrapper">
-<h1><a href="owner.html">npm owner</a></h1> <p>Manage package owners</p>
+<h1><a href="owner.html">owner</a></h1> <p>Manage package owners</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
@@ -16,6 +16,8 @@ <h2 id="SYNOPSIS">SYNOPSIS</h2>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
+<p>Manage ownership of published packages.</p>
+
<ul><li>ls:
List all the users who have access to modify a package and push new versions.
Handy when you need to know who to bug for help.</li><li>add:
@@ -30,7 +32,7 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
<h2 id="SEE-ALSO">SEE ALSO</h2>
-<ul><li><a href="publish.html">npm publish</a></li><li><a href="registry.html">npm registry</a></li><li><a href="adduser.html">npm adduser</a></li></ul>
+<ul><li><a href="publish.html">publish</a></li><li><a href="registry.html">registry</a></li><li><a href="adduser.html">adduser</a></li></ul>
</div>
<p id="footer">author &mdash; npm@1.0.28-pre-DEV-UNSTABLE</p>
<script>
@@ -55,7 +57,9 @@ <h2 id="SEE-ALSO">SEE ALSO</h2>
out += "</ul>"
l --
}
- out += "<li><a href='#" + el.id + "'>" + el.innerHTML + "</a>"
+ out += "<li><a href='#" + el.id + "'>" +
+ ( el.innerText || el.text || el.innerHTML)
+ + "</a>"
return out
}).join("\n")
toc.id = "toc"
View
@@ -6,7 +6,7 @@
<body>
<div id="wrapper">
-<h1><a href="bin.html">npm bin</a></h1> <p>Display npm bin folder</p>
+<h1><a href="bin.html">bin</a></h1> <p>Display npm bin folder</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
@@ -18,7 +18,7 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
<h2 id="SEE-ALSO">SEE ALSO</h2>
-<ul><li><a href="prefix.html">npm prefix</a></li><li><a href="root.html">npm root</a></li><li><a href="folders.html">npm folders</a></li><li><a href="config.html">npm config</a></li></ul>
+<ul><li><a href="prefix.html">prefix</a></li><li><a href="root.html">root</a></li><li><a href="folders.html">folders</a></li><li><a href="config.html">config</a></li></ul>
</div>
<p id="footer">bin &mdash; npm@1.0.28-pre-DEV-UNSTABLE</p>
<script>
@@ -43,7 +43,9 @@ <h2 id="SEE-ALSO">SEE ALSO</h2>
out += "</ul>"
l --
}
- out += "<li><a href='#" + el.id + "'>" + el.innerHTML + "</a>"
+ out += "<li><a href='#" + el.id + "'>" +
+ ( el.innerText || el.text || el.innerHTML)
+ + "</a>"
return out
}).join("\n")
toc.id = "toc"
View
@@ -6,7 +6,7 @@
<body>
<div id="wrapper">
-<h1><a href="build.html">npm build</a></h1> <p>Build a package</p>
+<h1><a href="build.html">build</a></h1> <p>Build a package</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
@@ -23,7 +23,7 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
<h2 id="SEE-ALSO">SEE ALSO</h2>
-<ul><li><a href="install.html">npm install</a></li><li><a href="link.html">npm link</a></li><li><a href="scripts.html">npm scripts</a></li><li><a href="json.html">npm json</a></li></ul>
+<ul><li><a href="install.html">install</a></li><li><a href="link.html">link</a></li><li><a href="scripts.html">scripts</a></li><li><a href="json.html">json</a></li></ul>
</div>
<p id="footer">build &mdash; npm@1.0.28-pre-DEV-UNSTABLE</p>
<script>
@@ -48,7 +48,9 @@ <h2 id="SEE-ALSO">SEE ALSO</h2>
out += "</ul>"
l --
}
- out += "<li><a href='#" + el.id + "'>" + el.innerHTML + "</a>"
+ out += "<li><a href='#" + el.id + "'>" +
+ ( el.innerText || el.text || el.innerHTML)
+ + "</a>"
return out
}).join("\n")
toc.id = "toc"
View
@@ -6,7 +6,7 @@
<body>
<div id="wrapper">
-<h1><a href="bundle.html">npm bundle</a></h1> <p>REMOVED</p>
+<h1><a href="bundle.html">bundle</a></h1> <p>REMOVED</p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
@@ -18,7 +18,7 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
<h2 id="SEE-ALSO">SEE ALSO</h2>
-<ul><li><a href="install.html">npm install</a></li></ul>
+<ul><li><a href="install.html">install</a></li></ul>
</div>
<p id="footer">bundle &mdash; npm@1.0.28-pre-DEV-UNSTABLE</p>
<script>
@@ -43,7 +43,9 @@ <h2 id="SEE-ALSO">SEE ALSO</h2>
out += "</ul>"
l --
}
- out += "<li><a href='#" + el.id + "'>" + el.innerHTML + "</a>"
+ out += "<li><a href='#" + el.id + "'>" +
+ ( el.innerText || el.text || el.innerHTML)
+ + "</a>"
return out
}).join("\n")
toc.id = "toc"
View
@@ -6,7 +6,7 @@
<body>
<div id="wrapper">
-<h1><a href="cache.html">npm cache</a></h1> <p>install a package</p>
+<h1><a href="cache.html">cache</a></h1> <p>install a package</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
@@ -21,6 +21,8 @@ <h2 id="SYNOPSIS">SYNOPSIS</h2>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
+<p>Used to add, list, or clear the npm cache folder.</p>
+
<ul><li><p>add:
Add the specified package to the local cache. This command is primarily
intended to be used internally by npm, but it can provide a way to
@@ -62,7 +64,7 @@ <h3 id="cache">cache</h3>
<h2 id="SEE-ALSO">SEE ALSO</h2>
-<ul><li><a href="folders.html">npm folders</a></li><li><a href="config.html">npm config</a></li><li><a href="install.html">npm install</a></li><li><a href="publish.html">npm publish</a></li><li><a href="pack.html">npm pack</a></li></ul>
+<ul><li><a href="folders.html">folders</a></li><li><a href="config.html">config</a></li><li><a href="install.html">install</a></li><li><a href="publish.html">publish</a></li><li><a href="pack.html">pack</a></li></ul>
</div>
<p id="footer">cache &mdash; npm@1.0.28-pre-DEV-UNSTABLE</p>
<script>
@@ -87,7 +89,9 @@ <h2 id="SEE-ALSO">SEE ALSO</h2>
out += "</ul>"
l --
}
- out += "<li><a href='#" + el.id + "'>" + el.innerHTML + "</a>"
+ out += "<li><a href='#" + el.id + "'>" +
+ ( el.innerText || el.text || el.innerHTML)
+ + "</a>"
return out
}).join("\n")
toc.id = "toc"
View
@@ -6,7 +6,11 @@
<body>
<div id="wrapper">
-<h1><a href="changelog.html">npm changelog</a></h1> <p>Changes</p>
+<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>
@@ -32,7 +36,7 @@ <h3 id="0-0">0.0</h3>
<h2 id="SEE-ALSO">SEE ALSO</h2>
-<ul><li><a href="npm.html">npm</a></li><li><a href="faq.html">npm faq</a></li></ul>
+<ul><li><a href="npm.html">npm</a></li><li><a href="faq.html">faq</a></li></ul>
</div>
<p id="footer">changelog &mdash; npm@1.0.28-pre-DEV-UNSTABLE</p>
<script>
@@ -57,7 +61,9 @@ <h2 id="SEE-ALSO">SEE ALSO</h2>
out += "</ul>"
l --
}
- out += "<li><a href='#" + el.id + "'>" + el.innerHTML + "</a>"
+ out += "<li><a href='#" + el.id + "'>" +
+ ( el.innerText || el.text || el.innerHTML)
+ + "</a>"
return out
}).join("\n")
toc.id = "toc"
View
@@ -6,7 +6,7 @@
<body>
<div id="wrapper">
-<h1><a href="coding-style.html">npm coding-style</a></h1> <p>npm's "funny" coding style</p>
+<h1><a href="coding-style.html">coding-style</a></h1> <p>npm's "funny" coding style</p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
@@ -155,7 +155,7 @@ <h2 id="Logging">Logging</h2>
occurs.</p>
<p>Use appropriate log levels. The default log() function logs at the
-"info" level. See <code><a href="config.html">npm config</a></code> and search for "loglevel".</p>
+"info" level. See <code><a href="config.html">config</a></code> and search for "loglevel".</p>
<h2 id="Case-naming-etc">Case, naming, etc.</h2>
@@ -189,7 +189,7 @@ <h2 id="null-undefined-false-0">null, undefined, false, 0</h2>
<h2 id="SEE-ALSO">SEE ALSO</h2>
-<ul><li><a href="developers.html">npm developers</a></li><li><a href="faq.html">npm faq</a></li><li><a href="npm.html">npm</a></li></ul>
+<ul><li><a href="developers.html">developers</a></li><li><a href="faq.html">faq</a></li><li><a href="npm.html">npm</a></li></ul>
</div>
<p id="footer">coding-style &mdash; npm@1.0.28-pre-DEV-UNSTABLE</p>
<script>
@@ -214,7 +214,9 @@ <h2 id="SEE-ALSO">SEE ALSO</h2>
out += "</ul>"
l --
}
- out += "<li><a href='#" + el.id + "'>" + el.innerHTML + "</a>"
+ out += "<li><a href='#" + el.id + "'>" +
+ ( el.innerText || el.text || el.innerHTML)
+ + "</a>"
return out
}).join("\n")
toc.id = "toc"
Oops, something went wrong.

0 comments on commit d5a920f

Please sign in to comment.