Accessibility: New Markdown files must start with Heading Level 2 because Book Title is Heading level 1
Open
Nobody has claimed this yet.
C-bug
- Dominant language
- Rust
- Stars
- 22.2k
- Forks
- 1.9k
- PR merge metrics
- PR metrics pending
Description
Problem
There must be only one Heading Level one present.
If Book Title is shown, its H1. Then all Markdown files need to Start with H2.
Steps
- Set book title
- Make entries in Summary.md
- Find that the entries all start with H1 "#" instead of H2 "##"
Possible Solution(s)
Start new Markdown files with H2 "##"
Notes
No response
Version
mdbook v0.4.37
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the steps with mdBook v0.4.37, using a book title and entries in Summary.md, then trace where the new Markdown files are created. Done means generated entry files begin with Heading Level 2 (##) when the book title occupies Heading Level 1 (#), with the existing behavior covered by an appropriate test.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, rust
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100