rust/doc
bors 98bd68343c auto merge of #7184 : smvv/rust/doc_css, r=brson
After reading issue #7077, all header elements had a border. In my opinion those borders are a bit too much distraction. I tried a different approach with increasing the padding and font size, and omitting the borders.

Comparison:
http://smvv.io/rust-doc/std/hashmap.html
http://static.rust-lang.org/doc/std/hashmap.html

Note: the highlighted code blocks are not caused by this commit.

I left the border of the code block / function signature as is. The reason behind that is that code blocks are really block elements, while headers are not. What do you guys think?
2013-06-16 20:16:01 -07:00
..
lib
lib.css
manual.css
prep.js
README
rust.css Remove h[123] border and increase their padding to better readability 2013-06-16 17:40:45 +02:00
rust.md Correct docs 2013-06-16 12:48:08 -04: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
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 fix benchmark and the tutorials 2013-06-16 01:19:43 -04:00
tutorial.md Correct tutorial tests 2013-06-16 12:47:36 -04: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