Home

Site Layout Right Sidebar Config

Right sidebar region configuration

Vertical sidebar on the right side of the page. Sub-regions flow top-to-bottom: start | middle | end. Auto-enabled when document has headings.

Typical components: toc-tree.

[site.layout.right-sidebar]
start = { type = "toc-tree", title = "Contents" }

Type: RegionConfig

enabled

Type: boolean (optional)

Explicit enable/disable (for use in overrides that also set sub-regions)

start

Type: array (optional)

Components in the start sub-region (left for horizontal, top for vertical)

middle

Type: array (optional)

Components in the middle sub-region (center)

end

Type: array (optional)

Components in the end sub-region (right for horizontal, bottom for vertical)

rows

Type: array (optional)

Multiple rows, each with their own start/middle/end sub-regions

When specified, start, middle, and end are ignored and each row is rendered separately. This enables multi-row layouts within a region.

Example (applicable to any region):

rows = [
  { middle = "prev-next" },
  { start = "edit-source", end = "copyright" }
]

responsive

Type: ResponsiveConfig (optional)

Responsive configuration (only applicable to sidebars)

Controls when the sidebar becomes collapsible and how the toggle appears.


This documentation was generated from layout/regions.rs by generate.rs.

© 2026 Stencila