rust/doc at 4c2e4c37ce01a98c768a986b0b87a6e93ef72699 - rust

mirror of https://github.com/rust-lang/rust.git synced 2024-11-26 16:54:01 +00:00

History

Tim Chevalier 0138d87f8f Document pub use foo::* in the reference manual r=brson Closes #3788		2012-12-12 16:38:36 -08:00
..
lib	Overhaul mods and crates section of tutorial	2012-10-06 22:24:15 -07:00
lib.css	Establish 'core' library separate from 'std'.	2011-12-06 12:13:04 -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	Document pub use foo::* in the reference manual	2012-12-12 16:38:36 -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 tutorial-ffi tests	2012-10-11 19:45:04 -07:00
tutorial-macros.md	Be a bit more explicit about the nature of macro RHSes.	2012-12-06 15:01:40 -08:00
tutorial-tasks.md	Fix tasks tutorial tests	2012-12-12 13:38:19 -08:00
tutorial.md	doc: add missing decls to example, r=burningtree.	2012-12-11 13:43:14 -08: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