mirrors/rust
0
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2024-12-01 13:18:54 +01:00
Code Issues Releases Activity
201039cf0d
rust/doc
History
Brian Anderson 201039cf0d tutorial: Discuss the primitive types along with their literals
2012-12-20 16:32:43 -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: 'trait constraints' -> 'inheritance'. Expand 2012-12-20 16:32:41 -08:00
tutorial-borrowed-ptr.md
tutorial-ffi.md
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 tutorial: Discuss the primitive types along with their literals 2012-12-20 16:32:43 -08:00
version_info.html.template

README 

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