Customization

Add an announcement banner to your docs

Prominently highlight new features, updates, or important information
View as Markdown

An announcement banner is a great way to draw attention to new features and product launches. When configured, the announcement bar appears at the top of your docs site. After the user dismisses the bar, it will reappear the next time you update the announcement.

docs.yml
1announcement:
2    message: "🚀 New feature: Announcements are available! (<a href=\"https://buildwithfern.com/learn/docs/building-your-docs/announcements\" target=\"_blank\">Learn more</a>) 🚀"

Markdown and HTML is supported in the announcement message. You can include links, images, and other formatting. Custom CSS can be used to customize the style of the announcement.

Configuring announcements at multiple levels

Announcements can 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.

The below example shows a multi-product docs site where the Docs product displays “Docs product is in beta”, the SDKs v1 version shows “v1 is in maintenance mode”, and the SDKs v2 version inherits the product-level message “New SDK features available!”

docs.yml
1# Config-level announcement (fallback for all products/versions)
2announcement:
3  message: "Welcome to our documentation!"
4
5products:
6  - display-name: Docs
7    path: ./products/docs/docs.yml
8    # Product-level announcement (overrides config-level for this product)
9    announcement:
10      message: "Docs product is in beta. Features may change."
11
12  - display-name: SDKs
13    path: ./products/sdks/sdks.yml
14    announcement:
15      message: "New SDK features available!"
16    
17    versions:
18      - display-name: v1
19        path: ./products/sdks/v1/docs.yml
20        # Version-level announcement (highest priority, overrides product and config)
21        announcement:
22          message: "v1 is in maintenance mode. Upgrade to v2."
23      
24      - display-name: v2
25        path: ./products/sdks/v2/docs.yml
26        # This version will show the product-level announcement