配置

为文档添加公告横幅

突出显示新功能、更新或重要信息

以 Markdown 格式查看

公告横幅是吸引用户关注新功能和产品发布的绝佳方式。配置后，公告栏会出现在文档站点的顶部。用户关闭横幅后，下次更新公告时它会重新出现。

docs.yml
1announcement:
2    message: "🚀 新功能：公告功能已上线！(<a href=\"https://buildwithfern.com/learn/docs/customization/announcement-banner\" target=\"_blank\">了解更多</a>) 🚀"

公告消息支持 Markdown 和 HTML。您可以包含链接、图片和其他格式。可以使用自定义 CSS 来自定义公告的样式。

在多个级别配置公告

可以在多个级别配置公告，以针对特定产品或版本。优先级层次结构为：

  1. 版本级别 - 最高优先级，为特定版本定义时始终显示
  2. 产品级别 - 当产品没有版本级别公告时使用
  3. 配置级别 - 当没有定义特定覆盖时，在所有产品/版本中显示的后备公告

将 announcement 属性直接添加到 docs.yml 文件中 products: 或 versions: 列表的项目中。

下面的示例显示了一个多产品文档站点，其中 Docs 产品显示”Docs 产品处于测试阶段”，SDKs v1 版本显示”v1 处于维护模式”，而 SDKs v2 版本继承产品级别的消息”新 SDK 功能已上线！”

docs.yml
1# 配置级别公告（所有产品/版本的后备）
2announcement:
3  message: "欢迎使用我们的文档！"
4
5products:
6  - display-name: Docs
7    path: ./products/docs/docs.yml
8    # 产品级别公告（为此产品覆盖配置级别）
9    announcement:
10      message: "Docs 产品处于测试阶段。功能可能会发生变化。"
11
12  - display-name: SDKs
13    path: ./products/sdks/sdks.yml
14    announcement:
15      message: "新 SDK 功能已上线！"
16    
17    versions:
18      - display-name: v1
19        path: ./products/sdks/v1/docs.yml
20        # 版本级别公告（最高优先级，覆盖产品和配置级别）
21        announcement:
22          message: "v1 处于维护模式。请升级到 v2。"
23      
24      - display-name: v2
25        path: ./products/sdks/v2/docs.yml
26        # 此版本将显示产品级别的公告