Layout

Everything on this page lives under site.chrome and applies on the next deepdoc serve, with no regeneration.

The full set

site:
  chrome:
    sidebar: true
    sidebar_default_open_level: 1
    sidebar_collapsible: true
    toc: true
    toc_style: clerk        # clerk | normal
    toc_depth: [2, 3]
    breadcrumb: true
    page_footer: true       # previous / next links
    edit_link: false
    last_update: true
    theme_switch: true
    search: true
    generated_meta: true
    links: []

Every key is optional. Set only what you want to change.

Sidebar

site:
  chrome:
    sidebar_default_open_level: 2   # expand one level deeper
    sidebar_collapsible: false      # readers cannot collapse it

sidebar_default_open_level controls how deep the tree starts expanded. On a large repository with many sections, 1 keeps the sidebar scannable; raise it when you have few sections and want everything visible.

Setting sidebar: false removes it entirely — reasonable for a handful of pages, rarely otherwise.

Table of contents

site:
  chrome:
    toc_style: normal      # or clerk
    toc_depth: [2, 3, 4]   # include h4 headings

toc_depth is the lever that matters. The default [2, 3] lists ## and ### headings. Add 4 when your pages use #### for meaningful subsections and readers need to jump to them — a reference page with one entry per configuration key, for instance.

toc_style picks between clerk (a highlighted active section) and normal.

Edit this page

site:
  repo_url: "https://github.com/acme/widgets"
  edit_branch: main
  edit_path_prefix: ""
  chrome:
    edit_link: true

Adds a link from each page to its source in your repository.

edit_path_prefix is for when your docs are not at the repository root — set it to the subdirectory, and it is prefixed to each page's path.

site.chrome.edit_link is on but no repository URL was found
(set site.repo_url, or add a git `origin` remote) — disabling the edit link.

Navbar links

site:
  chrome:
    links:
      - { text: "API", url: "https://api.acme.com" }
      - { text: "Status", url: "https://status.acme.com" }

Each entry needs both text and url. One missing a url is dropped with a warning rather than rendering a dead link.

The smaller switches

Invalid values never break a build

Every setting here is validated. A bad value warns and falls back:

site.chrome.toc_style: 'fancy' is not valid (clerk, normal) — using 'clerk'.
site.chrome.toc_depth: ['x'] is not a list of heading levels 1-6 — using [2, 3].

Your site still builds, with the default in place.

Next