Skip to main content
睿知宝 home page
使用指南

站点配置

通过 docs.json 管理睿知宝文档站点的品牌与多语言导航。

仓库根目录的 docs.json 是站点的统一配置入口。初始化后，通常先修改品牌信息，再调整页面导航。

品牌配置

{
  "name": "睿知宝",
  "description": "一句话说明这个文档站点的用途。",
  "colors": {
    "primary": "#6D5BD0",
    "light": "#8B7BE8",
    "dark": "#A99DF2"
  },
  "favicon": "/favicon.svg",
  "logo": {
    "light": "/logo/light.svg",
    "dark": "/logo/dark.svg"
  }
}
配置项建议
name使用完整、稳定的产品或团队名称
description用一句话说明文档面向谁、解决什么问题
colors使用品牌色，并检查亮暗模式下的对比度
logo分别提供适合亮色和暗色背景的 SVG 或 PNG
favicon使用简洁、在小尺寸下仍清晰的图标

多语言导航

每种语言维护自己的页面列表，路径需要包含语言目录： 
{
  "navigation": {
    "languages": [
      {
        "language": "zh",
        "label": "中文",
        "default": true,
        "tabs": [
          {
            "tab": "产品文档",
            "groups": [
              {
                "group": "开始使用",
                "pages": ["zh/index", "zh/quickstart"]
              }
            ]
          }
        ]
      },
      {
        "language": "en",
        "label": "English",
        "tabs": [
          {
            "tab": "Documentation",
            "groups": [
              {
                "group": "Get started",
                "pages": ["en/index", "en/quickstart"]
              }
            ]
          }
        ]
      }
    ]
  }
}
这是一个可直接使用的最小导航结构。增加页面时，请同时创建对应的 .mdx 文件，并将不带扩展名的路径加入相应语言的 pages。

发布前检查

  • docs.json 能被正确解析。
  • 导航中的每个路径都有对应 .mdx 文件。
  • 中英文页面之间没有串链。
  • Logo、favicon 和品牌色在亮暗模式下都清晰可见。
  • 所有外部链接均指向正式环境。
睿知宝 home page
开始使用
使用指南