Skip to main content
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: 
"banner": {
  "content": "🚀 Version 2.0 is now live! See our [changelog](/changelog) for details.",
  "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.
⌘I