横幅

添加横幅以展示全站重要公告与通知

使用横幅在整站文档中展示重要公告、更新或通知。横幅显示在每个页面的顶部，支持 Markdown 格式，并可设置为可关闭。横幅会采用 docs.json 中 colors.dark 属性定义的颜色。

要添加横幅，请在 docs.json 中使用 banner 属性：

Product announcements

"banner": {
  "content": "🚀 Version 2.0 is now live! See our [changelog](/changelog) for details.",
  "dismissible": true 
}

​

属性

content · string · 必填

横幅文案。支持纯文本和 Markdown 格式。

dismissible · boolean

是否允许用户关闭横幅。为 true 时，用户可将其关闭，且在当前会话内不会再次出现。默认值为 false。