rust/doc
Daniel Micay 8f2d71ac00 small fix to the tutorial-ffi destructor example
The previous example was erroneously attempting to destroy
uninitialized memory, which was often zeroed (masking the bug).
2013-05-04 21:57:10 -04:00
..
lib Remove fail keyword from lexer & parser and clean up remaining calls to 2013-02-01 00:15:42 -08:00
README add gitattributes and fix whitespace issues 2013-05-03 20:01:42 -04: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 add gitattributes and fix whitespace issues 2013-05-03 20:01:42 -04: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 small fix to the tutorial-ffi destructor example 2013-05-04 21:57:10 -04:00
tutorial-macros.md add gitattributes and fix whitespace issues 2013-05-03 20:01:42 -04:00
tutorial-tasks.md add gitattributes and fix whitespace issues 2013-05-03 20:01:42 -04:00
tutorial.md add gitattributes and fix whitespace issues 2013-05-03 20:01:42 -04:00
version_info.html.template add gitattributes and fix whitespace issues 2013-05-03 20:01:42 -04: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