Permalink
Browse files

More doc decruftifying

  • Loading branch information...
1 parent 4e35187 commit 609c9307b2368f9060fd74eef503779eff022c75 @isaacs isaacs committed Sep 4, 2011
Showing with 142 additions and 200 deletions.
  1. +7 −13 Makefile
  2. +2 −2 doc/help-search.md
  3. +2 −3 html/doc/adduser.html
  4. +3 −4 html/doc/author.html
  5. +2 −3 html/doc/bin.html
  6. +3 −4 html/doc/build.html
  7. +2 −3 html/doc/bundle.html
  8. +2 −3 html/doc/cache.html
  9. +2 −3 html/doc/changelog.html
  10. +2 −3 html/doc/coding-style.html
  11. +2 −3 html/doc/completion.html
  12. +2 −3 html/doc/config.html
  13. +2 −3 html/doc/deprecate.html
  14. +8 −9 html/doc/developers.html
  15. +2 −3 html/doc/docs.html
  16. +2 −3 html/doc/edit.html
  17. +2 −3 html/doc/explore.html
  18. +2 −3 html/doc/faq.html
  19. +2 −3 html/doc/folders.html
  20. +2 −3 html/doc/get.html
  21. +2 −3 html/doc/global.html
  22. +2 −3 html/doc/help-search.html
  23. +2 −3 html/doc/home.html
  24. +3 −4 html/doc/init.html
  25. +3 −4 html/doc/install.html
  26. +2 −3 html/doc/json.html
  27. +2 −3 html/doc/link.html
  28. +2 −3 html/doc/list.html
  29. +2 −3 html/doc/ln.html
  30. +2 −3 html/doc/ls.html
  31. +3 −4 html/doc/npm.html
  32. +2 −3 html/doc/outdated.html
  33. +3 −4 html/doc/owner.html
  34. +2 −3 html/doc/pack.html
  35. +2 −3 html/doc/prefix.html
  36. +2 −3 html/doc/prune.html
  37. +3 −4 html/doc/publish.html
  38. +2 −3 html/doc/rebuild.html
  39. +2 −3 html/doc/registry.html
  40. +2 −3 html/doc/removing-npm.html
  41. +3 −4 html/doc/restart.html
  42. +2 −3 html/doc/rm.html
  43. +2 −3 html/doc/root.html
  44. +3 −4 html/doc/run-script.html
  45. +2 −3 html/doc/scripts.html
  46. +2 −3 html/doc/search.html
  47. +1 −2 html/doc/semver.html
  48. +2 −3 html/doc/set.html
  49. +2 −3 html/doc/start.html
  50. +2 −3 html/doc/stop.html
  51. +2 −3 html/doc/submodule.html
  52. +2 −3 html/doc/tag.html
  53. +2 −3 html/doc/test.html
  54. +2 −3 html/doc/uninstall.html
  55. +2 −3 html/doc/unpublish.html
  56. +2 −3 html/doc/update.html
  57. +2 −3 html/doc/version.html
  58. +2 −3 html/doc/view.html
  59. +2 −3 html/doc/whoami.html
  60. +5 −0 man1/help-search.1
View
@@ -38,34 +38,28 @@ clean: uninstall
uninstall: submodules
node cli.js rm npm -g -f
-man: man1
-
-man1: $(doc_subfolders)
- [ -d man1 ] || mkdir -p man1
-
-html/doc: $(doc_subfolders)
- [ -d html/doc ] || mkdir -p html/doc
-
doc: $(docs) $(htmldocs)
# use `npm install ronn` for this to work.
-man1/%.1: doc/%.md man1
+man1/%.1: doc/%.md
@[ -x ./node_modules/.bin/ronn ] || node cli.js install ronn
+ @[ -d man1 ] || mkdir -p man1
./node_modules/.bin/ronn --roff $< > $@
-man1/%/: doc/%/ man1
+man1/%/: doc/%/
@[ -d $@ ] || mkdir -p $@
# use `npm install ronn` for this to work.
-html/doc/%.html: doc/%.md html/dochead.html html/docfoot.html html/doc
+html/doc/%.html: doc/%.md html/dochead.html html/docfoot.html
@[ -x ./node_modules/.bin/ronn ] || node cli.js install ronn
+ @[ -d html/doc ] || mkdir -p html/doc
(cat html/dochead.html && \
./node_modules/.bin/ronn -f $< && \
cat html/docfoot.html )\
| sed 's|@NAME@|$*|g' \
| sed 's|@DATE@|$(shell date -u +'%Y-%M-%d %H:%m:%S')|g' \
- | perl -pi -e 's/<h1>npm-([^\(]+\([0-9]\)) -- (.*?)<\/h1>/<h1>npm-\1<\/h1> <p>\2<\/p>/g' \
- | perl -pi -e 's/npm-([^\)]+)\(1\)/<a href="\1.html">npm-\1<\/a>/g' \
+ | perl -pi -e 's/<h1>npm(-?[^\(]*\([0-9]\)) -- (.*?)<\/h1>/<h1>npm\1<\/h1> <p>\2<\/p>/g' \
+ | perl -pi -e 's/npm-?([^\)]+)\(1\)/<a href="\1.html">npm \1<\/a>/g' \
| perl -pi -e 's/npm\(1\)/<a href="npm.html">npm<\/a>/g' \
| perl -pi -e 's/npm\(1\)/<a href="npm.html">npm<\/a>/g' \
> $@
View
@@ -1,5 +1,5 @@
-npm-help-search(1) Search npm help documentation
-================================================
+npm-help-search(1) -- Search npm help documentation
+===================================================
## SYNOPSIS
View
@@ -157,7 +157,6 @@
font-family:GubbleBum, gubblefont, monospace;
font-size:60px;
color:#900;
- xxx-text-shadow:#00f 1px 1px 1px;
display:block;
}
@@ -338,7 +337,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">npm adduser</a></h1> <p>Add a registry user account</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
@@ -395,4 +394,4 @@ <h3 id="registry">registry</h3>
</script>
</body></html>
-<!-- npm help adduser - 2011-35-04 07:09:04 -->
+<!-- npm help adduser - 2011-11-04 08:09:39 -->
View
@@ -157,7 +157,6 @@
font-family:GubbleBum, gubblefont, monospace;
font-size:60px;
color:#900;
- xxx-text-shadow:#00f 1px 1px 1px;
display:block;
}
@@ -338,7 +337,7 @@
<body>
<div id="wrapper">
-<h1><a href="owner.html">npm-owner</a></h1> <p>Manage package owners</p>
+<h1><a href="owner.html">npm owner</a></h1> <p>Manage package owners</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
@@ -362,7 +361,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></ul>
+<ul><li><a href="publish.html">npm publish</a></li><li><a href="registry.html">npm registry</a></li></ul>
</div>
<script>
els = Array.prototype.slice.call((wrapper = document.getElementById("wrapper"))
@@ -392,4 +391,4 @@ <h2 id="SEE-ALSO">SEE ALSO</h2>
</script>
</body></html>
-<!-- npm help author - 2011-35-04 07:09:05 -->
+<!-- npm help author - 2011-11-04 08:09:39 -->
View
@@ -157,7 +157,6 @@
font-family:GubbleBum, gubblefont, monospace;
font-size:60px;
color:#900;
- xxx-text-shadow:#00f 1px 1px 1px;
display:block;
}
@@ -338,7 +337,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">npm bin</a></h1> <p>Display npm bin folder</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
@@ -376,4 +375,4 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
</script>
</body></html>
-<!-- npm help bin - 2011-35-04 07:09:05 -->
+<!-- npm help bin - 2011-11-04 08:09:39 -->
View
@@ -157,7 +157,6 @@
font-family:GubbleBum, gubblefont, monospace;
font-size:60px;
color:#900;
- xxx-text-shadow:#00f 1px 1px 1px;
display:block;
}
@@ -338,7 +337,7 @@
<body>
<div id="wrapper">
-<h1><a href="build.html">npm-build</a></h1> <p>Build a package</p>
+<h1><a href="build.html">npm build</a></h1> <p>Build a package</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
@@ -355,7 +354,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">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>
</div>
<script>
els = Array.prototype.slice.call((wrapper = document.getElementById("wrapper"))
@@ -385,4 +384,4 @@ <h2 id="SEE-ALSO">SEE ALSO</h2>
</script>
</body></html>
-<!-- npm help build - 2011-35-04 07:09:05 -->
+<!-- npm help build - 2011-11-04 08:09:39 -->
View
@@ -157,7 +157,6 @@
font-family:GubbleBum, gubblefont, monospace;
font-size:60px;
color:#900;
- xxx-text-shadow:#00f 1px 1px 1px;
display:block;
}
@@ -338,7 +337,7 @@
<body>
<div id="wrapper">
-<h1><a href="bundle.html">npm-bundle</a></h1> <p>REMOVED</p>
+<h1><a href="bundle.html">npm bundle</a></h1> <p>REMOVED</p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
@@ -376,4 +375,4 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
</script>
</body></html>
-<!-- npm help bundle - 2011-35-04 07:09:05 -->
+<!-- npm help bundle - 2011-11-04 08:09:39 -->
View
@@ -157,7 +157,6 @@
font-family:GubbleBum, gubblefont, monospace;
font-size:60px;
color:#900;
- xxx-text-shadow:#00f 1px 1px 1px;
display:block;
}
@@ -338,7 +337,7 @@
<body>
<div id="wrapper">
-<h1><a href="cache.html">npm-cache</a></h1> <p>install a package</p>
+<h1><a href="cache.html">npm cache</a></h1> <p>install a package</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
@@ -420,4 +419,4 @@ <h3 id="cache">cache</h3>
</script>
</body></html>
-<!-- npm help cache - 2011-35-04 07:09:05 -->
+<!-- npm help cache - 2011-11-04 08:09:40 -->
View
@@ -157,7 +157,6 @@
font-family:GubbleBum, gubblefont, monospace;
font-size:60px;
color:#900;
- xxx-text-shadow:#00f 1px 1px 1px;
display:block;
}
@@ -338,7 +337,7 @@
<body>
<div id="wrapper">
-<h1><a href="changelog.html">npm-changelog</a></h1> <p>Changes</p>
+<h1><a href="changelog.html">npm changelog</a></h1> <p>Changes</p>
<h2 id="HISTORY">HISTORY</h2>
@@ -390,4 +389,4 @@ <h3 id="0-0">0.0</h3>
</script>
</body></html>
-<!-- npm help changelog - 2011-35-04 07:09:05 -->
+<!-- npm help changelog - 2011-11-04 08:09:40 -->
@@ -157,7 +157,6 @@
font-family:GubbleBum, gubblefont, monospace;
font-size:60px;
color:#900;
- xxx-text-shadow:#00f 1px 1px 1px;
display:block;
}
@@ -338,7 +337,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">npm coding-style</a></h1> <p>npm's "funny" coding style</p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
@@ -547,4 +546,4 @@ <h2 id="null-undefined-false-0">null, undefined, false, 0</h2>
</script>
</body></html>
-<!-- npm help coding-style - 2011-35-04 07:09:05 -->
+<!-- npm help coding-style - 2011-11-04 08:09:40 -->
View
@@ -157,7 +157,6 @@
font-family:GubbleBum, gubblefont, monospace;
font-size:60px;
color:#900;
- xxx-text-shadow:#00f 1px 1px 1px;
display:block;
}
@@ -338,7 +337,7 @@
<body>
<div id="wrapper">
-<h1><a href="completion.html">npm-completion</a></h1> <p>Tab Completion for npm</p>
+<h1><a href="completion.html">npm completion</a></h1> <p>Tab Completion for npm</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
@@ -387,4 +386,4 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
</script>
</body></html>
-<!-- npm help completion - 2011-35-04 07:09:05 -->
+<!-- npm help completion - 2011-11-04 08:09:40 -->
View
@@ -157,7 +157,6 @@
font-family:GubbleBum, gubblefont, monospace;
font-size:60px;
color:#900;
- xxx-text-shadow:#00f 1px 1px 1px;
display:block;
}
@@ -338,7 +337,7 @@
<body>
<div id="wrapper">
-<h1><a href="config.html">npm-config</a></h1> <p>Manage the npm configuration file</p>
+<h1><a href="config.html">npm config</a></h1> <p>Manage the npm configuration file</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
@@ -886,4 +885,4 @@ <h3 id="yes">yes</h3>
</script>
</body></html>
-<!-- npm help config - 2011-35-04 07:09:06 -->
+<!-- npm help config - 2011-11-04 08:09:40 -->
View
@@ -157,7 +157,6 @@
font-family:GubbleBum, gubblefont, monospace;
font-size:60px;
color:#900;
- xxx-text-shadow:#00f 1px 1px 1px;
display:block;
}
@@ -338,7 +337,7 @@
<body>
<div id="wrapper">
-<h1><a href="deprecate.html">npm-deprecate</a></h1> <p>Deprecate a version of a package</p>
+<h1><a href="deprecate.html">npm deprecate</a></h1> <p>Deprecate a version of a package</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
@@ -385,4 +384,4 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
</script>
</body></html>
-<!-- npm help deprecate - 2011-35-04 07:09:06 -->
+<!-- npm help deprecate - 2011-11-04 08:09:41 -->
View
@@ -157,7 +157,6 @@
font-family:GubbleBum, gubblefont, monospace;
font-size:60px;
color:#900;
- xxx-text-shadow:#00f 1px 1px 1px;
display:block;
}
@@ -338,7 +337,7 @@
<body>
<div id="wrapper">
-<h1><a href="developers.html">npm-developers</a></h1> <p>Developer Guide</p>
+<h1><a href="developers.html">npm developers</a></h1> <p>Developer Guide</p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
@@ -356,7 +355,7 @@ <h2 id="About-These-Documents">About These Documents</h2>
then do <code>man npm-thing</code> to get the documentation on a particular
topic.</p>
-<p>Any time you see "see <a href="whatever.html">npm-whatever</a>", you can do <code>man npm-whatever</code>
+<p>Any time you see "see <a href="whatever.html">npm whatever</a>", you can do <code>man npm-whatever</code>
or <code>npm help whatever</code> to get at the docs.</p>
<h2 id="What-is-a-package">What is a `package`</h2>
@@ -375,7 +374,7 @@ <h2 id="The-package-json-File">The package.json File</h2>
<p>You need to have a <code>package.json</code> file in the root of your project to do
much of anything with npm. That is basically the whole interface.</p>
-<p>See <a href="json.html">npm-json</a> for details about what goes in that file. At the very
+<p>See <a href="json.html">npm json</a> for details about what goes in that file. At the very
least, you need:</p>
<ul><li><p>name:
@@ -392,7 +391,7 @@ <h2 id="The-package-json-File">The package.json File</h2>
If you have a special compilation or installation script, then you
should put it in the <code>scripts</code> hash. You should definitely have at
least a basic smoke-test command as the "scripts.test" field.
-See <a href="scripts.html">npm-scripts</a>.</p></li><li><p>main:
+See <a href="scripts.html">npm scripts</a>.</p></li><li><p>main:
If you have a single module that serves as the entry point to your
program (like what the "foo" package gives you at require("foo")),
then you need to specify that in the "main" field.</p></li><li><p>directories:
@@ -401,7 +400,7 @@ <h2 id="The-package-json-File">The package.json File</h2>
they'll get installed just like these ones.</p></li></ul>
<p>You can use <code>npm init</code> in the root of your package in order to get you
-started with a pretty basic package.json file. See <code><a href="init.html">npm-init</a></code> for
+started with a pretty basic package.json file. See <code><a href="init.html">npm init</a></code> for
more info.</p>
<h2 id="Keeping-files-out-of-your-package">Keeping files *out* of your package</h2>
@@ -419,7 +418,7 @@ <h2 id="Link-Packages">Link Packages</h2>
need to either re-link or <code>npm rebuild -g</code> to update compiled packages,
of course.)</p>
-<p>More info at <code><a href="link.html">npm-link</a></code>.</p>
+<p>More info at <code><a href="link.html">npm link</a></code>.</p>
<h2 id="Before-Publishing-Make-Sure-Your-Package-Installs-and-Works">Before Publishing: Make Sure Your Package Installs and Works</h2>
@@ -459,7 +458,7 @@ <h2 id="Create-a-User-Account">Create a User Account</h2>
<p>and then follow the prompts.</p>
-<p>This is documented better in <a href="adduser.html">npm-adduser</a>. So do this to get the
+<p>This is documented better in <a href="adduser.html">npm adduser</a>. So do this to get the
details:</p>
<pre><code>npm help adduser</code></pre>
@@ -512,4 +511,4 @@ <h2 id="Brag-about-it">Brag about it</h2>
</script>
</body></html>
-<!-- npm help developers - 2011-35-04 07:09:06 -->
+<!-- npm help developers - 2011-11-04 08:09:41 -->
Oops, something went wrong.

0 comments on commit 609c930

Please sign in to comment.