MiniWiki logoMiniWiki

sidebar.json Reference #

File: content/sidebar.json

Most common edits #

  • Add a new sidebar section
  • Add links under an existing section
  • Add nested subcategories under a section
  • Reorder sections and links
  • Toggle section collapse behavior

Top-level keys #

KeyTypeRequiredDescription
sectionsarrayYesOrdered sidebar section list.

sections[] object keys #

Key pathTypeRequiredDescription
sections[].titlestringYesSection heading text.
sections[].collapsiblebooleanYesWhether section can be collapsed in UI.
sections[].itemsarrayYesList of navigable pages in section.

sections[].items[] object keys #

Key pathTypeRequiredDescription
sections[].items[].titlestringYesNavigation label for page.
sections[].items[].pathstringConditionallyURL/path target for that leaf item. Required when items/children is not present.
sections[].items[].collapsiblebooleanNoWhether this nested group can be collapsed (group items only).
sections[].items[].defaultOpenbooleanNoForces nested group open by default on first render.
sections[].items[].itemsarrayConditionallyNested subcategory list (group items only).
sections[].items[].childrenarrayConditionallyAlias for items for nested subcategory list.

Notes #

  • Order of sections controls sidebar section order.
  • Order of items controls link order within each section.
  • Nested groups auto-open when they contain the current page.

Add a new section (copy-ready) #

json
{
	"title": "My Section",
	"collapsible": true,
	"items": [
		{ "title": "Overview", "path": "/guides/my-section/overview" },
		{ "title": "Reference", "path": "/guides/my-section/reference" }
	]
}

Nested subcategories (copy-ready) #

json
{
	"title": "Components",
	"collapsible": true,
	"items": [
		{ "title": "Components Index", "path": "/guides/components/index" },
		{
			"title": "Layout",
			"collapsible": true,
			"items": [
				{ "title": "Header", "path": "/guides/components/header" },
				{ "title": "Sidebar", "path": "/guides/components/sidebar" },
				{ "title": "Footer", "path": "/guides/components/footer" }
			]
		}
	]
}
Edit this page