rust/doc
Brian Anderson f0c9927c26 Merge pull request #4708 from dforsyth/add_if
add if to borrowed ptr tutorial
2013-01-31 17:01:32 -08:00
..
lib Overhaul mods and crates section of tutorial 2012-10-06 22:24:15 -07:00
lib.css
manual.css Display the full TOC in the manual. Closes #4194 2012-12-14 18:06:21 -08:00
prep.js
README Added a readme explaining how to generate html from markdown docs w/o node 2012-11-18 09:08:31 -08:00
rust.css
rust.md Finalize moves-based-on-type implementation. 2013-01-31 12:09:00 -08:00
tutorial-borrowed-ptr.md add if to borrowed ptr tutorial 2013-01-31 09:10:15 -08:00
tutorial-ffi.md doc: fix tutorial unsafe blocks, r=burningtree. 2013-01-23 23:21:47 -08:00
tutorial-macros.md doc: Fix spelling error in macro tutorial 2013-01-12 18:36:46 -05:00
tutorial-tasks.md Finalize moves-based-on-type implementation. 2013-01-31 12:09:00 -08:00
tutorial.md librustc: Change self as a type to Self everywhere. r=brson 2013-01-30 19:52:45 -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