Navbar
Add external links to the top navigation bar.
The navbar array in docs.json adds links to the top bar of your rendered site. Use it to point readers to a dashboard, a GitHub repo, a changelog, or anywhere outside the docs.
Add navbar links
Each entry is an object with a name and a url.
{
"navbar": [
{ "name": "Dashboard", "url": "https://app.example.com" },
{ "name": "GitHub", "url": "https://github.com/acme/docs" }
]
}Links render in the order they appear in the array.
Highlight a call to action
Set variant to "primary" to render a link as a button instead of plain text. Use it for the one action you most want readers to take — signing up, opening the dashboard, starting a trial.
{
"navbar": [
{ "name": "GitHub", "url": "https://github.com/acme/docs" },
{ "name": "Dashboard", "url": "https://app.acme.com", "variant": "primary" }
]
}The button is outlined rather than filled, so it stands out from the other links without competing with your content. It picks up its border and hover colors from your theme.
Ordering is still just array order, so move the entry to control where the button sits. Nothing stops you marking several links "primary", but a navbar with one obvious action reads better than one with three competing ones.
Fields
| Field | Type | Required | Notes |
|---|---|---|---|
name | string | Yes | The label shown in the top bar. |
url | string | Yes | Absolute URL (https://...) or a relative path (/changelog) to a page on your own site. |
variant | "link" | "primary" | No | "link" (the default) is plain text. "primary" renders an outlined button. |
The navbar field itself is optional. Omit it and no links appear in the top bar.
Where the links render
Links render in the top bar to the right of the search field. Absolute URLs starting with http:// or https:// open in a new tab; relative paths open in the same tab.
On narrow screens the top bar hides its links to make room. They move into the sidebar menu instead, above the page navigation, keeping the same order — a "primary" link becomes a full-width button there.