rust/doc
Huon Wilson 3ac00a9489 std: remove substr & str::count_*, methodise char_len, implement slice_chars.
The confusing mixture of byte index and character count meant that every
use of .substr was incorrect; replaced by slice_chars which only uses
character indices. The old behaviour of `.substr(start, n)` can be emulated
via `.slice_from(start).slice_chars(0, n)`.
2013-06-12 12:21:04 +10:00
..
lib
README add gitattributes and fix whitespace issues 2013-05-03 20:01:42 -04:00
lib.css
manual.css
prep.js
rust.css
rust.md fix tests, remove some warnings 2013-06-11 02:34:14 +10:00
rustpkg.md docs: Mention recently-added rustpkg features in the rustpkg manual 2013-06-02 17:21:01 -07:00
tutorial-borrowed-ptr.md Replace shared/unique by managed/owned in the tutorial 2013-05-14 22:25:55 +09:00
tutorial-ffi.md librustc: Disallow multiple patterns from appearing in a "let" declaration. 2013-06-04 21:45:42 -07:00
tutorial-macros.md librustc: Disallow multiple patterns from appearing in a "let" declaration. 2013-06-04 21:45:42 -07:00
tutorial-tasks.md std: convert pow, hypot, atan2, log to take arguments by reference. 2013-06-11 11:36:03 +10:00
tutorial.md std: remove substr & str::count_*, methodise char_len, implement slice_chars. 2013-06-12 12:21:04 +10: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