make doc

brucejo75 · Sep 8, 2011 · d5a920f · d5a920f
1 parent 55d2677
commit d5a920f
Show file tree

Hide file tree

Showing 76 changed files with 406 additions and 234 deletions.
diff --git a/doc/cache.md b/doc/cache.md
@@ -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

diff --git a/doc/changelog.md b/doc/changelog.md
@@ -1,6 +1,10 @@
 npm-changelog(1) -- Changes
 ===========================
 
+## SYNOPSIS
+
+A brief history.
+
 ## HISTORY
 
 ### 1.0  

diff --git a/doc/completion.md b/doc/completion.md
@@ -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.

diff --git a/doc/faq.md b/doc/faq.md
@@ -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:

diff --git a/doc/link.md b/doc/link.md
@@ -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.

diff --git a/doc/owner.md b/doc/owner.md
@@ -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.

diff --git a/doc/removing-npm.md b/doc/removing-npm.md
@@ -1,7 +1,7 @@
 npm-removal(1) -- Cleaning the Slate
 ====================================
 
-## SUMMARY
+## SYNOPSIS
 
 So sad to see you go.
 

diff --git a/doc/semver.md b/doc/semver.md
@@ -1,7 +1,11 @@
 npm-semver(1) -- The semantic versioner for npm
 ===============================================
 
-## Usage
+## SYNOPSIS
+
+The npm semantic versioning utility.
+
+## DESCRIPTION
 
 As a node module:
 

diff --git a/html/doc/README.html b/html/doc/README.html
@@ -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; [email protected]</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"

diff --git a/html/doc/adduser.html b/html/doc/adduser.html
@@ -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; [email protected]</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"

diff --git a/html/doc/author.html b/html/doc/author.html
@@ -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; [email protected]</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"

diff --git a/html/doc/bin.html b/html/doc/bin.html
@@ -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; [email protected]</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"

diff --git a/html/doc/build.html b/html/doc/build.html
@@ -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; [email protected]</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"

diff --git a/html/doc/bundle.html b/html/doc/bundle.html
@@ -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; [email protected]</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"

diff --git a/html/doc/cache.html b/html/doc/cache.html
@@ -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; [email protected]</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"

diff --git a/html/doc/changelog.html b/html/doc/changelog.html
@@ -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; [email protected]</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"

diff --git a/html/doc/coding-style.html b/html/doc/coding-style.html
@@ -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; [email protected]</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"