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:

​
Properties

​
string
required
The banner message. Supports plain text and Markdown formatting.
​
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.

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

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