横幅 - Mintlify

使用横幅在整个文档站点显示重要公告、更新或通知。横幅会显示在每个页面顶部，支持 Markdown 格式，并可设置为可关闭。要添加横幅，请在你的 docs.json 中使用 banner 属性：

"banner": {
  "content": "🚀 2.0 版本现已上线！查看我们的[变更日志](/changelog)了解详情。",
  "dismissible": true 
}

"banner": {
  "content": "⚠️ 计划维护：12 月 15 日 02:00–04:00（UTC）期间 API 将不可用",
  "dismissible": false
}

"banner": {
  "content": "**需要操作：** 请在 1 月 1 日前迁移到我们的新版本。[迁移指南](/migration)",
  "dismissible": true
}

属性

string

必填

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

boolean

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