0
0
mirror of https://github.com/rust-lang/rust.git synced 2024-12-01 13:18:54 +01:00
rust/doc
Tim Chevalier b1b0c297a4 Merge pull request #4249 from graydon/0.6-bump
bump 0.5 => 0.6, redirect some URLs in docs.
2012-12-23 13:47:11 -08:00
..
lib
lib.css
manual.css Display the full TOC in the manual. Closes #4194 2012-12-14 18:06:21 -08:00
prep.js
README
rust.css
rust.md doc: Mention argument bindings in manual 2012-12-20 17:01:38 -08:00
tutorial-borrowed-ptr.md
tutorial-ffi.md Fix example. 2012-12-23 13:26:12 -08: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 Merge pull request #4249 from graydon/0.6-bump 2012-12-23 13:47:11 -08: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