Skip to main content
使用横幅在整个文档站点显示重要公告、更新或通知。横幅会显示在每个页面顶部,支持 Markdown 格式,并可设置为可关闭。横幅使用你的 docs.jsoncolors.dark 属性定义的颜色。 要添加横幅,请在你的 docs.json 中使用 banner 属性:

属性

string
必填
横幅文案。支持纯文本和 Markdown 格式。
boolean
是否允许用户关闭横幅。为 true 时,用户可将其关闭,且在当前会话内不会再次出现。默认值为 false

语言特定横幅

在文档中为每种语言配置不同的横幅内容。在 docs.jsonnavigation.languages 数组中定义语言特定的横幅。

回退行为

横幅在确定要显示哪个内容时遵循以下优先顺序:
  1. 特定语言横幅:如果当前语言有 banner 配置,则以该配置为准。
  2. 全局横幅:如果不存在特定语言横幅,则显示全局 banner