rust/doc
2013-01-10 20:48:49 -08:00
..
lib
lib.css
manual.css Display the full TOC in the manual. Closes #4194 2012-12-14 18:06:21 -08:00
prep.js
README
rust.css
rust.md doc: Fix some typos in the tutorial and reference manual 2012-12-31 13:46:52 -08:00
tutorial-borrowed-ptr.md
tutorial-ffi.md Fix example. 2012-12-24 18:29:02 -08:00
tutorial-macros.md Remove spurious semicolons at the end of macro_rules! definitions. 2012-12-29 01:37:00 -05:00
tutorial-tasks.md Remove spawn_listener, spawn_conversation 2012-12-14 14:59:32 -08:00
tutorial.md corrected imprecision in description of mutable fields 2013-01-10 20:48:49 -08: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