Permalink
Browse files

Conversion to markdown based API docs.

With help from Matt Ranney <mjr@ranney.com>
  • Loading branch information...
1 parent 6ecdead commit 179f718d62c17c674a941a2539b81fee54152da5 @creationix creationix committed with ry Mar 26, 2010
Showing with 2,165 additions and 2,385 deletions.
  1. +5 −13 Makefile
  2. +1 −2 README
  3. +2,159 −0 doc/api.markdown
  4. +0 −2,033 doc/api.txt
  5. +0 −167 doc/asciidoc-xhtml11.js
  6. +0 −61 doc/common.xsl
  7. +0 −109 doc/toc.js
View
@@ -41,30 +41,22 @@ benchmark: all
doc: doc/node.1 doc/api.html doc/index.html doc/changelog.html
-doc/api.html: doc/api.txt
- asciidoc --unsafe \
- -a theme=pipe \
- -a toc \
- -a toclevels=1 \
- -a linkcss \
- -o doc/api.html doc/api.txt
+doc/api.html: doc/api.markdown
+ ronn --html doc/api.markdown > doc/api.html
doc/changelog.html: ChangeLog
echo '<html><head><title>Node.js ChangeLog</title> <link rel="stylesheet" href="./pipe.css" type="text/css" /> <link rel="stylesheet" href="./pipe-quirks.css" type="text/css" /> <body><h1>Node.js ChangeLog</h1> <pre>' > doc/changelog.html
cat ChangeLog >> doc/changelog.html
echo '</pre></body></html>' >> doc/changelog.html
-doc/api.xml: doc/api.txt
- asciidoc -b docbook -d manpage -o doc/api.xml doc/api.txt
-
-doc/node.1: doc/api.xml
- xsltproc --output doc/node.1 --nonet doc/manpage.xsl doc/api.xml
+doc/node.1: doc/api.markdown
+ ronn --roff doc/api.markdown > doc/node.1
website-upload: doc
scp doc/* ryan@nodejs.org:~/tinyclouds/node/
docclean:
- @-rm -f doc/node.1 doc/api.xml doc/api.html doc/changelog.html
+ @-rm -f doc/node.1 doc/api.html doc/changelog.html
clean:
@$(WAF) clean
View
3 README
@@ -10,8 +10,7 @@ To run the tests:
make test
-To build the documentation and install it, you will need asciidoc and
-xsltproc:
+To build the documentation and install it, you will need ronn:
make doc install
Oops, something went wrong.

0 comments on commit 179f718

Please sign in to comment.