Skip to navigation

Product and version-specific announcement banners

Announcement banners can now be configured at multiple levels to target specific products or versions.

The override hierarchy is:

  1. Version-level - Highest priority, always shown when defined for a specific version
  2. Product-level - Used when no version-level announcement exists for a product
  3. Config-level - Fallback announcement shown across all products/versions when no specific override is defined

Add the announcement property directly to items in the products: or versions: lists in your docs.yml file:

docs.yml
# Config-level announcement (fallback)
announcement:
message: "Welcome to our documentation!"
products:
- display-name: Docs
path: ./products/docs/docs.yml
# Product-level announcement
announcement:
message: "Docs product is in beta."
versions:
- display-name: v1
path: ./products/docs/v1/docs.yml
# Version-level announcement (highest priority)
announcement:
message: "v1 is in maintenance mode. Upgrade to v2."
Read the docs