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.
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. |
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.