Sidebar

The sidebar is automatically generated from your file structure. You can control the ordering and grouping of items through configuration and file metadata.

Group Order

Use sidebar.groupOrder to control the order that groups appear in the sidebar:

sidebar: {
  groupOrder: ["Getting Started", "Writing", "Configuration", "Advanced"],
},

Groups not listed in groupOrder appear after the listed ones, sorted alphabetically.

Folder-Based Grouping

Folders in your docs directory automatically become sidebar groups. The folder name is converted to a title (e.g., getting-started becomes "Getting Started").

To customize a group's label, add an index.tiramisu file inside the folder:

meta {
  title = My Custom Group Name
}

The title from the index file becomes the group label in the sidebar.

Root-Level Grouping

Files at the root of a section (not in a subfolder) can be grouped using the group field in their meta block:

meta {
  title = My Page,
  group = Getting Started,
  order = 1
}

Ordering Pages

Pages within a group are sorted by their order value (lower numbers appear first). If no order is specified, pages are sorted alphabetically by title.

meta {
  title = Installation,
  order = 2
}

Subgroups

Nested folders create subgroups in the sidebar. These appear as collapsible sections within their parent group:

The index.tiramisu in writing/ defines the "Writing" group label. The index.tiramisu in content/ defines the "Content" subgroup label.