rust/doc
2013-05-30 15:26:25 +02:00
..
lib Remove fail keyword from lexer & parser and clean up remaining calls to 2013-02-01 00:15:42 -08: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 add gitattributes and fix whitespace issues 2013-05-03 20:01:42 -04:00
rust.css rustdoc: Tweak list style 2013-03-26 09:31:44 -07:00
rust.md Minor grammar fix. 2013-05-30 15:26:25 +02:00
rustpkg.md rustpkg: In doc, mention other implicit RUST_PATH entries 2013-04-22 18:17:32 -07:00
tutorial-borrowed-ptr.md Replace shared/unique by managed/owned in the tutorial 2013-05-14 22:25:55 +09:00
tutorial-ffi.md librustc: Stop reexporting the standard modules from prelude. 2013-05-29 19:04:53 -07:00
tutorial-macros.md Use static string with fail!() and remove fail!(fmt!()) 2013-05-14 16:36:23 +02:00
tutorial-tasks.md librustc: Stop reexporting the standard modules from prelude. 2013-05-29 19:04:53 -07:00
tutorial.md librustc: Stop reexporting the standard modules from prelude. 2013-05-29 19:04:53 -07:00
version_info.html.template add gitattributes and fix whitespace issues 2013-05-03 20:01:42 -04: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