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 you can make them dismissible. By default, banners use the color defined by the colors.dark property in your docs.json. You can change the appearance with the type property or override the background entirely with color. 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
}
You can also configure banners per language by setting banner in navigation.languages. See Language-specific banners.

​
Properties

​
content
string
required
The text content displayed in the banner. Supports basic MDX formatting including links, bold, and italic text. Custom components are not supported.
​
dismissible
boolean
Whether users can dismiss the banner. When true, a close button appears. If a user closes the banner, it stays hidden for them until you update the banner content. Defaults to false.
​
type
string
The visual style of the banner. Controls the background color so visitors can quickly recognize the urgency of the message. Defaults to info.
  • info: Uses the primary brand color. Best for product announcements and general updates.
  • warning: Uses an amber background. Best for cautionary notices like scheduled maintenance or upcoming deprecations.
  • critical: Uses a red background. Best for urgent notices that require immediate attention, such as outages or required actions.
​
color
object
Override the banner background color with a custom hex value. When set, this takes precedence over the color implied by type. Banner text is white, so choose a background dark enough to remain legible.

​
Language-specific banners

Configure different banner content for each language in your documentation. Define language-specific banners in the navigation.languages array in your docs.json. 
{
  "navigation": {
    "languages": [
      {
        "language": "en",
        "banner": {
          "content": "🚀 Version 2.0 is now live! See our [changelog](/en/changelog) for details.",
          "dismissible": true
        },
        "groups": [
          {
            "group": "Getting started",
            "pages": ["en/overview", "en/quickstart"]
          }
        ]
      },
      {
        "language": "es",
        "banner": {
          "content": "🚀 ¡La versión 2.0 ya está disponible! Consulta nuestro [registro de cambios](/es/changelog) para más detalles.",
          "dismissible": true
        },
        "groups": [
          {
            "group": "Getting started",
            "pages": ["es/overview", "es/quickstart"]
          }
        ]
      }
    ]
  },
  "banner": {
    "content": "🚀 Version 2.0 is now live!",
    "dismissible": true
  }
}

​
Fallback behavior

Banners follow a priority order when determining which content to display:
  1. Language-specific banner: If the current language has a banner configuration, it takes priority.
  2. Global banner: If no language-specific banner exists, display the global banner.

Related topics

Site structuredocs.json schema referenceUse the assistant