mirror of
https://github.com/rust-lang/rust.git
synced 2024-11-28 01:34:21 +00:00
b4501f4c64
Patches for further documentation of them welcome, but this is good enough for now. Closes #1107 |
||
|---|---|---|
| .. | ||
| lib | ||
| lib.css | ||
| prep.js | ||
| README | ||
| rust.css | ||
| rust.md | ||
| tutorial-borrowed-ptr.md | ||
| tutorial-ffi.md | ||
| tutorial-macros.md | ||
| tutorial-tasks.md | ||
| tutorial.md | ||
| 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