使用横幅在整个文档站点显示重要公告、更新或通知。横幅会显示在每个页面顶部，支持 Markdown 格式，并且你可以将其设置为可关闭。默认情况下，横幅使用你的 docs.json 中 colors.dark 属性定义的颜色。你可以使用 type 属性更改外观，或使用 color 完全覆盖背景。
要添加横幅，请在你的 docs.json 中使用 banner 属性：
"banner": {
"content": "🚀 2.0 版本现已上线！查看我们的[更新日志](/changelog)了解详情。",
"dismissible": true
}
你也可以通过在 navigation.languages 中设置 banner 来按语言配置横幅。参见特定语言横幅。 横幅中显示的文本内容。支持基本的 MDX 格式，包括链接、粗体和斜体文本。不支持自定义组件。
是否允许用户关闭横幅。为 true 时，会显示关闭按钮。如果用户关闭了横幅，横幅将对该用户保持隐藏，直到你更新横幅内容。默认值为 false。
横幅的视觉样式。控制背景颜色，让访客能够快速识别消息的紧急程度。默认值为 info。
info：使用主要品牌色。最适合产品公告和常规更新。warning：使用琥珀色背景。最适合警示性通知，例如计划维护或即将到来的弃用。critical：使用红色背景。最适合需要立即关注的紧急通知，例如服务中断或必需操作。
使用自定义十六进制值覆盖横幅背景颜色。设置后，将优先于 type 所暗示的颜色。横幅文本为白色，因此请选择足够深的背景以保持可读性。
在浅色模式下使用的十六进制颜色。如果只提供 dark，则也会在浅色模式下使用。
在深色模式下使用的十六进制颜色。如果只提供 light，则也会在深色模式下使用。
docs.json 的 navigation.languages 数组中定义语言特定的横幅。
{
"navigation": {
"languages": [
{
"language": "en",
"banner": {
"content": "🚀 Version 2.0 is now live! See our [changelog](/en/changelog) for details.",
"dismissible": true
},
"groups": [
{
"group": "Getting started",
"pages": ["en/overview", "en/quickstart"]
}
]
},
{
"language": "es",
"banner": {
"content": "🚀 ¡La versión 2.0 ya está disponible! Consulta nuestro [registro de cambios](/es/changelog) para más detalles.",
"dismissible": true
},
"groups": [
{
"group": "Getting started",
"pages": ["es/overview", "es/quickstart"]
}
]
}
]
},
"banner": {
"content": "🚀 Version 2.0 is now live!",
"dismissible": true
}
}
- 特定语言横幅：如果当前语言有
banner 配置，则以该配置为准。
- 全局横幅：如果不存在特定语言横幅，则显示全局
banner。
