rust-lang / rust-lang/mdBook

Collapse/fold `sidebar-header-nav`

Open
#3,054 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

C-enhancement
Dominant language
Rust
Stars
22.2k
Forks
1.9k
PR merge metrics
PR metrics pending

Description

Problem

Section-folding affects only the chapters and sub-chapters. It doesn't allow collapsing or folding the page headers creating by the sidebar-header-nav (#2822).

Proposed Solution

Add a new option like output.html.fold.headers = true to enable collapsing the headers.

Notes

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the implementation of sidebar-header-nav and comparing it with the existing output.html.fold section-folding behavior. Read the linked mdBook renderer configuration documentation and determine how a new output.html.fold.headers option should be exposed. Done means page headers can be collapsed when enabled without changing the existing chapter-folding behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.