TOC depth in sidebar heading navigation
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 22.2k
- Forks
- 1.9k
- PR merge metrics
- PR metrics pending
Description
Question
Recent release 0.5.0 brings sidebar heading navigation (#2822) which is great. However now my TOC is really huge since some pages have up to 3 or 4 level of heading sections.
Is there a way to specify the max TOC depth? Would make my TOC look much better (without having to heavily update my documentation).
I like this new feature and don't want to disable it.
Version
0.5.1
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
Start by reading the sidebar heading navigation work in #2822 and tracing how heading levels are collected for the TOC. Identify the configuration and tests, then make the maximum depth selectable while keeping the existing navigation enabled; done means deeper headings are omitted according to that setting.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100