Navigation

Customize how users navigate your documentation.

Header CTAs

Add call-to-action buttons to the header:

navigation:
  cta:
    - text: Get Started
      href: /getting-started
      variant: primary
    - text: GitHub
      href: https://github.com/example/repo
      variant: secondary
      external: true

Maximum of 2 CTAs are displayed.

Header Tabs

Add top-level navigation tabs for large documentation sites:

tabs:
  - text: Docs
    href: /docs
  - text: API
    href: /api
    icon: code
  - text: Blog
    href: https://blog.example.com
    external: true

Tabs filter the sidebar to show only content under the active tab’s path.

Breadcrumbs

Breadcrumbs show the path to the current page. Enabled by default.

To disable:

navigation:
  breadcrumbs: false

Breadcrumbs are automatically truncated when the path has more than 3 levels.

Prev/Next Links

Navigation links at the bottom of each page are auto-generated from your sidebar structure.

Disable for a Page

---
title: My Page
prev: false
next: false
---

Custom Links

Override with a page title:

---
title: My Page
prev: "Getting Started"
next: "Advanced Usage"
---

Or specify both text and link:

---
title: My Page
prev:
  text: "Back to Intro"
  link: /intro
next:
  text: "Continue to API"
  link: /api
---

Table of Contents

The table of contents (TOC) is automatically generated from h2-h4 headings on each page. It appears in the right sidebar on desktop.

Heading Levels

The TOC includes:

• ## Heading 2 - Top level
• ### Heading 3 - Nested
• #### Heading 4 - Deeply nested

Best Practices

• Use clear, descriptive headings
• Keep heading text concise
• Maintain a logical hierarchy (don’t skip levels)

Complete Example

# Header tabs for multi-section docs
tabs:
  - text: Guide
    href: /guide
  - text: API Reference
    href: /api
    icon: code
  - text: Examples
    href: /examples

# Header CTAs
navigation:
  cta:
    - text: Get Started
      href: /guide/quickstart
      variant: primary
    - text: GitHub
      href: https://github.com/example/repo
      variant: secondary
      external: true
  breadcrumbs: true

Reference

Header CTA Options

Header Tab Options

Navigation Config

Prev/Next Frontmatter