rust/doc at e0f9f89c6575c79fc2afba6abf0c17c384c81e3b - rust

History

Brian Anderson e0f9f89c65 tutorial: Remove confusing discussion about semicolons This takes up a lot of words and isn't very clear. The previous discussion gets they idea across. /cc: #4217		2012-12-20 16:32:42 -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	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: 'trait constraints' -> 'inheritance'. Expand	2012-12-20 16:32:41 -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	Add a section to the macro tutorial about recursive macros.	2012-12-16 18:45:54 -05:00
tutorial-tasks.md	Remove spawn_listener, spawn_conversation	2012-12-14 14:59:32 -08:00
tutorial.md	tutorial: Remove confusing discussion about semicolons	2012-12-20 16:32:42 -08:00
version_info.html.template

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