Update to mdbook 0.5 #3883
Update to mdbook 0.5 #3883
Conversation
ehuss
added
the
not-rfc
|
The new sidebar is really nice. Exciting to use it in other places. Regarding that sidebar, I noticed that it doesn't take into account Level 1 heading, is that expected? should we update all the RFCs to reduce the heading by one? We are missing the Summary, Motivation, ... headings on all RFCs. 
|
|
Hm, that's a good point. Yea, it is expected as mdbook expects a chapter to have only one level-1 heading (usually the chapter title at the top). At the risk of causing complete chaos, I pushed a commit that corrects the heading levels. Pages generally shouldn't have multiple h1 headings anyways. |
|
I'm fine updating all the headings. However we should also update the level of all the other headings (h2 -> h3, h3 -> h4, ...), otherwise the sections no longer have the right parent.
|
This increases the heading level so that RFCs do not contain multiple level-1 headings. mdbook expects that chapters have only a single level-1 heading (and that usually should be at the very top). More than one h1 element on a page is generally not recommended (for example, https://www.a11yproject.com/posts/how-to-accessible-heading-structure/#one-h1).
|
Well shoot. I thought my replacements handled that. I have re-pushed the commit which should fix that. I ended up using pulldown-cmark to more accurately detect the headings. Unfortunately a large number of RFCs had weird heading levels. So I went through manually visually inspected each RFC to see if the nesting looked odd and fixed any RFC that looked weird (that was maybe 10-15% of them). |
As part of rust-lang#3883, we have switched the template to stop using level-1 headings which isn't the way mdbook is intended to be used.
As part of rust-lang#3883, we have switched the template to stop using level-1 headings which isn't the way mdbook is intended to be used.
As part of rust-lang#3883, we have switched the template to stop using level-1 headings which isn't the way mdbook is intended to be used.
Updated section headers to use Markdown 2nd level headings. As part of #3883 we switched the template to not use level-1 headings. r? Turbo87
As part of rust-lang#3883, we have switched the template to stop using level-1 headings which isn't the way mdbook is intended to be used.
As part of rust-lang#3883, we have switched the template to stop using level-1 headings which isn't the way mdbook is intended to be used.
As part of rust-lang#3883, we have switched the template to stop using level-1 headings which isn't the way mdbook is intended to be used.
3 participants
Changelog: https://github.com/rust-lang/mdBook/blob/master/CHANGELOG.md#mdbook-051
Rendered