mirrors/rust
0
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2024-11-29 18:06:44 +01:00
Code Issues Releases Activity
319eeb1c79
rust/doc
History
Daniel Micay 319eeb1c79 rename map -> oldmap and mark it as deprecated 
LinearMap is quite a bit faster, and is fully owned/sendable without
requiring copies. The older std::map also doesn't use explicit self and
relies on mutable fields.
2013-02-03 15:55:10 -05: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 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 rename map -> oldmap and mark it as deprecated 2013-02-03 15:55:10 -05: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 Remove fail keyword from lexer & parser and clean up remaining calls to 2013-02-01 00:15:42 -08:00
tutorial.md rename map -> oldmap and mark it as deprecated 2013-02-03 15:55:10 -05:00
version_info.html.template Rename the template for version_info.html 2012-08-20 14:04:12 -07:00

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