rust/doc
John Clements 18f1dba510 doc typo 2013-01-25 11:58:33 -08:00
..
lib Overhaul mods and crates section of tutorial 2012-10-06 22:24:15 -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
lib.css Establish 'core' library separate from 'std'. 2011-12-06 12:13:04 -08:00
manual.css Display the full TOC in the manual. Closes #4194 2012-12-14 18:06:21 -08:00
prep.js fix escape 2012-10-05 12:41:00 -07:00
rust.css docs: Tweak style 2012-09-30 21:35:32 -07:00
rust.md doc typo 2013-01-25 11:58:33 -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 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 doc: Fix tutorial typo and remove unnecessary xfail-test 2013-01-20 22:56:45 -08:00
tutorial.md doc: Document pattern matching on vectors 2013-01-23 22:26:47 +09:00
version_info.html.template Rename the template for version_info.html 2012-08-20 14:04:12 -07:00

README

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