rust/doc
Jed Davis 4701716b56 Revert "doc: XFAIL mysterious failure on bots"
This reverts commit 2c6dae081b.
2013-04-30 12:07:10 -07:00
..
lib Remove fail keyword from lexer & parser and clean up remaining calls to 2013-02-01 00:15:42 -08:00
README Added a readme explaining how to generate html from markdown docs w/o node 2012-11-18 09:08:31 -08:00
lib.css Establish 'core' library separate from 'std'. 2011-12-06 12:13:04 -08:00
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
rust.css rustdoc: Tweak list style 2013-03-26 09:31:44 -07:00
rust.md Revert "doc: XFAIL mysterious failure on bots" 2013-04-30 12:07:10 -07:00
rustpkg.md rustpkg: In doc, mention other implicit RUST_PATH entries 2013-04-22 18:17:32 -07:00
tutorial-borrowed-ptr.md librustc: Modify all code to use new lifetime binder syntax 2013-03-26 21:30:17 -07:00
tutorial-ffi.md tutorial-ffi: add example of a custom destructor 2013-04-26 14:07:57 -04:00
tutorial-macros.md Copyedit macro tutorial 2013-03-22 16:11:27 -07:00
tutorial-tasks.md core::comm: Modernize constructors to use `new` 2013-04-18 14:07:35 -07:00
tutorial.md tutorial: Fix 'self' to 'Self' 2013-04-29 17:59:25 +09: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