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. Banners use the color defined by the colors.dark property in your docs.json. 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 
}
Banners can also be configured on a per-language basis by setting the banner property in navigation.languages.

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