rust/doc
bors 292e946163 auto merge of #5106 : pnkfelix/rust/fix-docs, r=graydon
...s.  I freely admit I have not run a "make check" on this (trivial) change.
2013-02-27 19:03:41 -08: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 auto merge of #5106 : pnkfelix/rust/fix-docs, r=graydon 2013-02-27 19:03:41 -08:00
tutorial-borrowed-ptr.md doc: Remove references to mut fields. rs=demuting 2013-02-26 10:02:36 -08:00
tutorial-ffi.md doc: Remove references to mut fields. rs=demuting 2013-02-26 10:02:36 -08:00
tutorial-macros.md remove die definition and use in doc tests 2013-02-14 17:33:16 -08:00
tutorial-tasks.md Fix unused imports in the tutorials 2013-02-26 17:52:16 -05:00
tutorial.md libsyntax: Forbid ~mut and ~const. rs=demuting 2013-02-27 09:40:15 -08:00
version_info.html.template

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