> Agent-readable docs index: /llms.txt. Download /docs.zip to grep all markdown files locally.

---
"$schema": https://holocron.so/frontmatter.json
title: Navigation
description: Tabs, groups, anchors, and sidebar structure.
icon: panel-left
---

<Aside full>
  <TableOfContentsPanel />
</Aside>

# Navigation

The `navigation` field in `docs.jsonc` controls the sidebar, tab bar, and overall site structure. Holocron supports the same navigation shapes as Mintlify.

## Simplest form: flat groups

For small sites, use a flat array of groups. This creates a single sidebar with collapsible sections:

```jsonc
{
  "navigation": [
    {
      "group": "Getting Started",
      "pages": ["index", "quickstart"]
    },
    {
      "group": "Guides",
      "pages": ["guides/auth", "guides/deployment"]
    }
  ]
}
```

## Tabs

Tabs split the sidebar into multiple top-level areas. Each tab has its own set of groups. Clicking a tab switches the sidebar content:

```jsonc
{
  "navigation": {
    "tabs": [
      {
        "tab": "Documentation",
        "groups": [
          { "group": "Overview", "pages": ["index"] },
          { "group": "Guides", "pages": ["guides/setup"] }
        ]
      },
      {
        "tab": "API Reference",
        "openapi": "openapi.json"
      }
    ]
  }
}
```

<Note>
  This template uses tabs. The **Documentation** tab shows these guide pages, and the **API Reference** tab is generated from the `api.yaml` OpenAPI spec.
</Note>

### Link-only tabs

A tab can be an external link instead of a content section:

```jsonc
{
  "tab": "GitHub",
  "href": "https://github.com/your-org/your-repo"
}
```

## Nested groups

Groups can contain other groups for deeper hierarchy:

```json
{
  "group": "Authentication",
  "pages": [
    "auth/overview",
    {
      "group": "Providers",
      "pages": ["auth/github", "auth/google", "auth/email"]
    }
  ]
}
```

## Group options

| Field      | Type    | Description                                |
| ---------- | ------- | ------------------------------------------ |
| `group`    | string  | Section title in the sidebar               |
| `pages`    | array   | Page slugs or nested groups                |
| `icon`     | string  | Icon next to the group title               |
| `hidden`   | boolean | Hide the entire group                      |
| `expanded` | boolean | Start the group expanded                   |
| `root`     | string  | Page slug for the group's clickable header |
| `tag`      | string  | Badge label next to the group title        |

## Anchors

Anchors are persistent external links in the tab bar. They appear alongside tabs regardless of which tab is active:

```json
{
  "navigation": {
    "global": {
      "anchors": [
        { "anchor": "GitHub", "href": "https://github.com/example", "icon": "github" },
        { "anchor": "Website", "href": "https://holocron.so", "icon": "globe" }
      ]
    }
  }
}
```

## Navbar links

Add links to the top-right corner of the navbar (next to the logo):

```json
{
  "navbar": {
    "links": [
      { "type": "github", "href": "https://github.com/your-org/your-repo" },
      { "label": "Blog", "href": "https://example.com/blog" }
    ],
    "primary": {
      "type": "button",
      "label": "Get Started",
      "href": "/quickstart"
    }
  }
}
```


---

*Powered by [holocron.so](https://holocron.so)*