---
title: Site Banner
description: Show a dismissable announcement banner at the top of every page.
url: http://localhost:3040/guides/site-banner
---

# Site Banner

Show a dismissable announcement banner at the top of every page.

A site banner appears above the navigation bar on every page — useful for launch announcements, deprecation notices, or important alerts. Users can dismiss it and it won't reappear (stored in `localStorage`).

## Configuration

Add a `banner` block to `docs.json`:

```json
"banner": {
  "content": "We just launched v2! [Read the announcement →](/changelog)",
  "dismissible": true
}
```

The banner is rendered immediately — no code changes needed, just redeploy after updating `docs.json`.

## Fields

| Field | Type | Default | Description |
| --- | --- | --- | --- |
| `content` | `string` | — | Banner text. Supports `[label](url)` markdown links. |
| `dismissible` | `boolean` | `true` | Whether to show an × button to hide the banner |

## Markdown links

The `content` field supports inline markdown link syntax: `[text](url)`. Internal and external links both work.

```json
"banner": {
  "content": "New: [Multi-language docs](/guides/multi-language) are now available",
  "dismissible": true
}
```

## Removing the banner

Delete the `banner` key from `docs.json` and redeploy. Users who previously dismissed it will see no change; users who had not dismissed it will no longer see it.

To force users to see an updated banner even if they dismissed a previous one, change the `content` text. The dismissal is keyed to the exact content string.