0
0
mirror of https://github.com/rust-lang/rust.git synced 2024-11-29 18:06:44 +01:00
rust/doc
Tim Chevalier cfb33fc23c Merge pull request #4311 from FranklinChen/fix-macro-tutorial
Remove semicolons at the end of macro_rules! definitions that cause compile failure
2012-12-30 15:53:18 -08:00
..
lib Overhaul mods and crates section of tutorial 2012-10-06 22:24:15 -07: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 Added a readme explaining how to generate html from markdown docs w/o node 2012-11-18 09:08:31 -08:00
rust.css docs: Tweak style 2012-09-30 21:35:32 -07:00
rust.md doc: mention struct-like enum variants /cc #4217 2012-12-24 15:59:37 -08:00
tutorial-borrowed-ptr.md Fix typo in borrowed pointer tutorial. Closes #3876 2012-10-29 13:52:05 -07:00
tutorial-ffi.md Fix example. 2012-12-23 13:26:12 -08:00
tutorial-macros.md Remove spurious semicolons at the end of macro_rules! definitions. 2012-12-29 01:37:00 -05:00
tutorial-tasks.md Remove spawn_listener, spawn_conversation 2012-12-14 14:59:32 -08:00
tutorial.md doc: make small corrections to tutorial 2012-12-30 16:09:34 -05:00
version_info.html.template Rename the template for version_info.html 2012-08-20 14:04:12 -07: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