26a5c9768b
I was making documentation for my own little Rust project, and I was somewhat unhappy with how the documentation looked. While many of the issues are endemic to how rustdoc generates its output, you can get pretty far in making the documentation readable by using a better CSS style. This commit alters the CSS style used in Rust's documentation in order to make the various sections stand out more. You can see an example of its usage in my own project's documentation: http://siegelord.github.io/RustGnuplot/#implementation-for-figureself-where-self. I showed it to some people on IRC and they suggested that I make a pull request here. I tested it on the only browser that matters, but also Chrome and Opera. |
||
|---|---|---|
| .. | ||
| lib | ||
| lib.css | ||
| manual.css | ||
| prep.js | ||
| README | ||
| rust.css | ||
| rust.md | ||
| rustpkg.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