You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: 'Use banners to display important site-wide announcements and notifications'
4
+
icon: 'megaphone'
5
+
---
6
+
7
+
Use banners to display important announcements, updates, or notifications across your entire documentation site. Banners appear at the top of every page and support Markdown formatting.
8
+
9
+
## Configuration
10
+
11
+
Add a banner to your `docs.json` file. The banner supports Markdown formatting and can be made dismissible:
12
+
13
+
```json
14
+
{
15
+
"banner": {
16
+
"content": "🚀 **New feature released!** [Check out our latest updates](/changelog)",
17
+
"dismissible": true
18
+
}
19
+
}
20
+
```
21
+
22
+
When `dismissible` is `true`, users can close the banner and it won't reappear for their session.
23
+
24
+
## Examples
25
+
26
+
<Tabs>
27
+
<Tabtitle="Product announcements">
28
+
```json
29
+
{
30
+
"banner": {
31
+
"content": "🚀 Version 2.0 is now live! [See what's new](/changelog)",
32
+
"dismissible": true
33
+
}
34
+
}
35
+
```
36
+
</Tab>
37
+
<Tabtitle="Maintenance notices">
38
+
```json
39
+
{
40
+
"banner": {
41
+
"content": "⚠️ Scheduled maintenance: API will be unavailable Dec 15, 2-4 AM UTC",
42
+
"dismissible": false
43
+
}
44
+
}
45
+
```
46
+
</Tab>
47
+
<Tabtitle="Migration alerts">
48
+
```json
49
+
{
50
+
"banner": {
51
+
"content": "📋 **Action required:** Migrate to our new API by Jan 1st. [Migration guide](/migration)",
0 commit comments