0
0
mirror of https://github.com/rust-lang/rust.git synced 2024-11-25 12:12:19 +01:00
rust/doc
2013-05-01 15:40:05 +10:00
..
lib
lib.css
manual.css
prep.js
README
rust.css
rust.md Revert rename of Div to Quot 2013-05-01 15:40:05 +10:00
rustpkg.md
tutorial-borrowed-ptr.md
tutorial-ffi.md tutorial-ffi: add example of a custom destructor 2013-04-26 14:07:57 -04:00
tutorial-macros.md
tutorial-tasks.md
tutorial.md tutorial: Fix 'self' to 'Self' 2013-04-29 17:59:25 +09: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