> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ficcaurora.xyz/llms.txt
> Use this file to discover all available pages before exploring further.
# 全局设置
> Mintlify 通过 docs.json 让你完全掌控文档站点的外观与行为
每个 Mintlify 站点都需要一个包含核心配置的 `docs.json` 文件。下面了解[各字段属性](#properties)。
## Properties
项目名称。用于全局标题显示。
示例：`mintlify`
导航分组数组，包含各分组下的所有页面。
分组名称。
示例：`Settings`
作为页面渲染的 markdown 文件相对路径。
示例：`["customization", "page"]`
logo 路径，或包含亮色/暗色模式 logo 路径的对象。
亮色模式下的 logo 路径
暗色模式下的 logo 路径
点击 logo 时跳转到的链接
站点 favicon 图标路径
站点主题的十六进制颜色配置
主色。常用于（浅色模式下）的高亮内容、章节标题、强调等。
暗色模式下的主色。常用于（深色模式下）的高亮内容、章节标题、强调等。
重要按钮的主色
浅色与深色模式下的背景色
浅色模式下背景的十六进制颜色
深色模式下背景的十六进制颜色
顶部栏链接的数组，包含 `name` 与 `url`。
按钮名称。
示例：`Contact us`
点击按钮后跳转的链接。例如：`https://mintlify.com/docs`
`link` 显示按钮；`github` 显示指定仓库的信息（包括 GitHub stars 数）。
当为 `link`：按钮跳转的链接。
当为 `github`：用于加载 GitHub 信息的仓库地址。
按钮内的文案。仅当 `type` 为 `link` 时必填。
版本名称数组。若需在导航栏显示版本下拉，请使用此字段。
锚点数组，包含 `icon`、`color` 与 `url`。
用于展示锚点的 [Font Awesome](https://fontawesome.com/search?q=heart) 图标。
示例：`comments`
锚点标签名称。
示例：`Community`
URL 前缀，标识属于该锚点的页面。通常与放置页面的文件夹名一致。
锚点图标背景的十六进制颜色。也可传对象提供渐变（包含 `from` 与 `to` 两个颜色值）。
若希望在选择特定文档版本之前隐藏某锚点，可使用本字段。
若传 `true`，则默认隐藏该锚点，除非通过直达链接访问其下页面。
可选："brands"、"duotone"、"light"、"sharp-solid"、"solid" 或 "thin"
覆盖最顶层锚点的默认配置。
顶层锚点的名称
Font Awesome 图标。
可选："brands"、"duotone"、"light"、"sharp-solid"、"solid" 或 "thin"
导航选项卡数组。
选项卡标签名称。
URL 前缀，标识属于该选项卡的页面。通常与你放置页面的文件夹名一致。
API 相关配置。关于 API 页面详见[API 组件](/api-playground/demo)。
全部 API 端点的基础 URL。若 `baseUrl` 为数组，则启用多基础 URL 的切换。
所有 API 端点使用的认证方式。
API playground 中认证参数的名称。
若 method 为 `basic`，格式应为 `[usernameName]:[passwordName]`
认证输入框的默认前缀值。
例如：若 `inputPrefix` 为 `AuthKey`，则该字段的默认输入值为 `AuthKey`。
API playground 的配置。
playground 的展示模式：显示、隐藏，或 `simple`（仅显示端点，无交互）。
详见[playground 指南](/api-playground/demo)
启用后，OpenAPI 页面中的键顺序将与 OpenAPI 文件中定义的顺序一致。
此行为即将默认启用，届时本字段将被弃用。
指向 OpenAPI 文件的 URL 或相对路径（单个字符串或字符串数组）。
示例：
```json Absolute theme={null}
"openapi": "https://example.com/openapi.json"
```
```json Relative theme={null}
"openapi": "/openapi.json"
```
```json Multiple theme={null}
"openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"]
```
社媒账号对象，key 为平台名、value 为该平台的账号 URL。
示例：
```json theme={null}
{
"x": "https://x.com/mintlify",
"website": "https://mintlify.com"
}
```
可选值之一：`website`、`facebook`、`x`、`discord`、`slack`、`github`、`linkedin`、`instagram`、`hacker-news`
示例：`x`
该平台的链接 URL。
示例：`https://x.com/mintlify`
启用反馈按钮的配置。
启用按钮，允许用户通过 pull request 提出修改建议。
启用按钮，允许用户对文档提出 Issue。
自定义明暗模式切换。
若设置，将对新用户固定为明或暗模式；未设置时默认跟随用户系统偏好。
设为 true 可隐藏明/暗模式切换。可与 `default` 组合以强制仅使用某一模式。例如：
```json Only Dark Mode theme={null}
"modeToggle": {
"default": "dark",
"isHidden": true
}
```
```json Only Light Mode theme={null}
"modeToggle": {
"default": "light",
"isHidden": true
}
```
在每个页面后方显示的背景图片。示例可参考
[Infisical](https://infisical.com/docs) 与 [FRPC](https://frpc.io)。