search

rust-embedded / rust-embedded.github.io

A collection of books and other documents about embedded Rust
https://docs.rust-embedded.org
Apache License 2.0
84 stars 8 forks source link

Added numeration to headings #3

Closed caemor closed 6 years ago

caemor commented 6 years ago

Added numeration to the different headings for faster and clearer visual separation similar to https://doc.rust-lang.org/.

I am not sure if it is yet needed for the sections where only one h2-heading exists but it looks much more appealing to me at least.

japaric commented 6 years ago

Thanks for the PR!

I believe that if we build index.md without the --markdown-no-toc flag rustdoc will add these numbers automatically. At least that's the case for the FAQ. Could you check?

I don't have much opinions on this other that I would prefer if we don't have to manually update these numbers.

caemor commented 6 years ago

Without --markdown-no-toc it will add these numbers automatically. It's the same as the FAQ but that also means that it isn't the same the doc.rust-lang.org site because it has the same Table of Contents to the top as the FAQ.

Edit: added a screenshot for NOT using the --markdown-no-tocflag where you can see the TOC at the top: image