Banner

Add a banner to display important site-wide announcements and notifications

Use banners to display important announcements, updates, or notifications across your entire documentation site. Banners appear at the top of every page, support Markdown formatting, and can be made dismissible.

To add a banner, use the banner property in your docs.json:

Product announcements

"banner": {
  "content": "🚀 Version 2.0 is now live! See our [changelog](/changelog) for details.",
  "dismissible": true 
}

"banner": {
  "content": "⚠️ Scheduled maintenance: API will be unavailable December 15, 2-4 AM UTC",
  "dismissible": false
}

"banner": {
  "content": "**Action required:** Migrate to our new version by January 1. [Migration guide](/migration)",
  "dismissible": true
}

Properties

content · string · required

The banner message. Supports plain text and Markdown formatting.

dismissible · boolean

Whether users can dismiss the banner. When true, users can close the banner and it won’t reappear for their session. Defaults to false.