全局设置

使用 docs.json 配置你的 Mintlify 文档站点，这是控制导航、外观、集成等内容的必需配置文件。

docs.json 文件是 Mintlify 文档站点的核心配置文件。它控制站点的全局设置，包括视觉品牌、导航结构、集成、API 设置等。可以把它看作站点的蓝图。

​

必需字段

你必须定义四个字段才能构建一个可用的站点。

字段	描述
name	你的项目或组织名称
theme	站点的布局主题
colors.primary	主品牌颜色，使用十六进制代码
navigation	你的内容结构

所有其他字段都是可选的。你可以在自定义和完善站点时逐步添加它们。

​

最小配置

为了获得最佳编辑体验，请在 docs.json 的顶部包含 $schema 引用。这将在大多数编辑器中启用自动补全、校验和内联文档。

docs.json

{
  "$schema": "https://mintlify.com/docs.json",
  "theme": "mint",
  "name": "你的项目名称",
  "colors": {
    "primary": "#ff0000"
  },
  "navigation": [
    {
      "group": "首页",
      "pages": ["index"]
    }
  ]
}

​

设置

外观与品牌

自定义站点的视觉外观，包括主题、颜色、logo、favicon、字体和背景。

站点结构

设计站点的信息架构和用户体验，包括导航栏、页脚、横幅、导航和重定向。

API 设置

控制 API 文档的显示和行为，包括 OpenAPI 和 AsyncAPI 规范、API 演练场和代码示例。

集成

将站点连接到第三方服务，用于分析、聊天等功能。

SEO 和搜索

控制搜索引擎如何索引你的站点，包括 meta 标签、搜索和页面时间戳。

Schema 参考

所有 docs.json 属性的完整参考。

​

从 mint.json 升级

如果你的项目使用已弃用的 mint.json 文件，请按照以下步骤升级到 docs.json。

1. 安装或更新 CLI

   如果你还没有安装 CLI，现在安装它：

   npm

   npm i -g mint
   

   如果你已经安装了 CLI，确保它是最新版本：

   mint update
   
2. 创建你的 docs.json 文件

   在你的文档仓库中运行：

   mint upgrade
   

   此命令会从你现有的 mint.json 创建一个 docs.json 文件。检查生成的文件以确保所有设置正确。

3. 删除你的 mint.json 文件

   在确认 docs.json 配置正确后，你可以安全地删除旧的 mint.json 文件。