rust/doc
bors 2815742ba5 auto merge of #5669 : graydon/rust/tweaks, r=thestinger
Just some minor cleanup of version strings and copyrights.
2013-04-01 18:00:43 -07:00
..
lib
lib.css
manual.css
prep.js
README
rust.css rustdoc: Tweak list style 2013-03-26 09:31:44 -07:00
rust.md docs: Xfail test, it's just for illustration anyway 2013-04-01 15:21:22 -07:00
tutorial-borrowed-ptr.md librustc: Modify all code to use new lifetime binder syntax 2013-03-26 21:30:17 -07:00
tutorial-ffi.md librustc: Remove fail_unless! 2013-03-29 16:39:08 -07:00
tutorial-macros.md Copyedit macro tutorial 2013-03-22 16:11:27 -07:00
tutorial-tasks.md librustc: Remove fail_unless! 2013-03-29 16:39:08 -07:00
tutorial.md tidy version numbers and copyright dates 2013-04-01 16:15:49 -07:00
version_info.html.template

The markdown docs are only generated by make when node is installed (use
`make doc`). If you don't have node installed you can generate them yourself. 
Unfortunately there's no real standard for markdown and all the tools work 
differently. pandoc is one that seems to work well.

To generate an html version of a doc do something like:
pandoc --from=markdown --to=html --number-sections -o build/doc/rust.html doc/rust.md && git web--browse build/doc/rust.html

The syntax for pandoc flavored markdown can be found at:
http://johnmacfarlane.net/pandoc/README.html#pandocs-markdown

A nice quick reference (for non-pandoc markdown) is at:
http://kramdown.rubyforge.org/quickref.html