0
0
mirror of https://github.com/rust-lang/rust.git synced 2024-12-01 13:18:54 +01:00
rust/doc
Brian Anderson 3b396d17d6 Merge remote-tracking branch 'thestinger/old_map' into incoming
Conflicts:
	src/test/bench/core-map.rs
2013-02-03 17:56:49 -08: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
prep.js
README
rust.css
rust.md Merge remote-tracking branch 'thestinger/old_map' into incoming 2013-02-03 17:56:49 -08:00
tutorial-borrowed-ptr.md add if to borrowed ptr tutorial 2013-01-31 09:10:15 -08:00
tutorial-ffi.md doc: fix tutorial unsafe blocks, r=burningtree. 2013-01-23 23:21:47 -08:00
tutorial-macros.md Remove fail keyword from lexer & parser and clean up remaining calls to 2013-02-01 00:15:42 -08:00
tutorial-tasks.md Fixed fmt!, tests, doc-tests. 2013-02-03 15:37:25 -08:00
tutorial.md rename map -> oldmap and mark it as deprecated 2013-02-03 15:55:10 -05: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