Add TOC

[lovelydinosaur]

Make page.toc available for templating, and include in the default theme.

[Copilot]

Pull request overview

This PR exposes a rendered table of contents (page.toc) in the template context and updates the built-in theme to render that TOC as a sidebar.

Changes:

• Add toc to the page template context via a new PageContext object.
• Update the default theme template to render {{ page.toc }} and adjust layout/CSS for a TOC sidebar.
• Remove the previous “default” theme template and standalone CSS assets (now inlined in src/mkdocs/theme/base.html).

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/mkdocs/theme/base.html	Adds TOC sidebar markup and CSS; adjusts main layout and responsive behavior.
src/mkdocs/mkdocs.py	Introduces PageContext with toc; passes md.toc into templates; tweaks Markdown TOC config.
src/mkdocs/default/style.css	Removed (styles appear to be consolidated into the theme template).
src/mkdocs/default/highlight.css	Removed (highlight styles appear to be consolidated into the theme template).
src/mkdocs/default/favicon.html	Removed (favicon is now inlined in the theme template).
src/mkdocs/default/base.html	Removed (replaced by src/mkdocs/theme/base.html).

Suppressed comments (2)

src/mkdocs/theme/base.html:178

• The TOC styles are applied to the generic nav selector, which will also affect any <nav> elements coming from {{ page.html }} (markdown/shortcodes). Scope the fixed positioning rule to the TOC nav (e.g., nav.toc) to avoid breaking user content.

nav {
    position: fixed;
    margin-left: 80%;
    width : 20%;
    padding: 2rem;
    height: 100%;
    overflow-y: scroll;
}

src/mkdocs/theme/base.html:186

• Similarly, the TOC list/link styles use generic nav ul/li/a selectors, which can restyle any <nav> in page content. Scope these selectors to the TOC nav so only the generated TOC is affected.

nav ul {
    padding: 0;
    margin: 0;
}

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.