0
0
mirror of https://github.com/rust-lang/rust.git synced 2024-12-01 13:18:54 +01:00
rust/doc
Tim Chevalier 1d1b81143b Merge pull request #4589 from sanxiyn/doc-vec-match
doc: Document pattern matching on vectors
2013-01-23 14:38:34 -08:00
..
lib
lib.css
manual.css
prep.js
README
rust.css
rust.md doc: Document mutable function arguments 2013-01-23 17:20:36 +09:00
tutorial-borrowed-ptr.md
tutorial-ffi.md Revert "doc: Fix tutorial-ffi xfail-tests and update SHA1() to use size_t" 2013-01-21 19:39:45 -08:00
tutorial-macros.md
tutorial-tasks.md doc: Fix tutorial typo and remove unnecessary xfail-test 2013-01-20 22:56:45 -08:00
tutorial.md doc: Document pattern matching on vectors 2013-01-23 22:26:47 +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