rust/doc
2012-12-08 11:47:03 -08:00
..
lib Overhaul mods and crates section of tutorial 2012-10-06 22:24:15 -07:00
lib.css Establish 'core' library separate from 'std'. 2011-12-06 12:13:04 -08:00
prep.js fix escape 2012-10-05 12:41:00 -07:00
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 docs: Tweak style 2012-09-30 21:35:32 -07:00
rust.md doc: Fix broken doc test. rs=bustage 2012-12-08 11:47:03 -08:00
tutorial-borrowed-ptr.md Fix typo in borrowed pointer tutorial. Closes #3876 2012-10-29 13:52:05 -07:00
tutorial-ffi.md Fix tutorial-ffi tests 2012-10-11 19:45:04 -07:00
tutorial-macros.md Be a bit more explicit about the nature of macro RHSes. 2012-12-06 15:01:40 -08:00
tutorial-tasks.md Make moves explicit in doc examples 2012-10-12 20:43:37 -07:00
tutorial.md Fix tutorial's use of Drop 2012-11-29 16:23:24 -08:00
version_info.html.template Rename the template for version_info.html 2012-08-20 14:04:12 -07:00

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