跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://mintlify-mintlify-editor-tree-1777307411.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

使用横幅在整个文档站点显示重要公告、更新或通知。横幅会显示在每个页面顶部，支持 Markdown 格式，并且你可以将其设置为可关闭。横幅使用你的 docs.json 中 colors.dark 属性定义的颜色。 要添加横幅，请在你的 docs.json 中使用 banner 属性： 
"banner": {
  "content": "🚀 2.0 版本现已上线！查看我们的[更新日志](/changelog)了解详情。",
  "dismissible": true 
}
你也可以通过在 navigation.languages 中设置 banner 来按语言配置横幅。参见特定语言横幅。

​
属性

​
content
string
必填
横幅中显示的文本内容。支持基本的 MDX 格式，包括链接、粗体和斜体文本。不支持自定义组件。
​
dismissible
boolean
是否允许用户关闭横幅。为 true 时，会显示关闭按钮。如果用户关闭了横幅，横幅将对该用户保持隐藏，直到你更新横幅内容。默认值为 false。

​
语言特定横幅

在文档中为每种语言配置不同的横幅内容。在 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
  }
}

​
回退行为

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