rust/doc
2012-11-18 09:23:09 -08:00
..
lib
lib.css
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 Improved attribute section, mostly by mentioning lint attributes. 2012-11-18 09:23:09 -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
tutorial-macros.md Talk about ends, rather than means, in macro tutorial introduction. 2012-10-20 21:54:25 -04:00
tutorial-tasks.md Make moves explicit in doc examples 2012-10-12 20:43:37 -07:00
tutorial.md Minor grammatical edits; use preferred nomenclature consistently. 2012-11-11 16:19:40 +00: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