> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ticoag.fun/llms.txt
> Use this file to discover all available pages before exploring further.
# 全局设置
> 通过 docs.json，Mintlify 让你完全掌控文档站点的外观与体验
每个 Mintlify 站点都需要一个 `docs.json` 文件来承载核心配置。下面介绍常用 [属性（properties）](#properties)。
## 属性（Properties）
项目名称，用于全局标题（global title）。
示例：`mintlify`
分组数组，每个分组包含该组内的页面
分组名称。
示例：`Settings`
作为页面渲染的 Markdown 文件相对路径。
示例：`["customization", "page"]`
Logo 图片路径，或包含「light / dark」两套 logo 路径的对象
浅色模式下的 logo 路径
深色模式下的 logo 路径
点击 logo 后跳转到的链接
favicon 图片路径
全局主题配色（Hex color）
主色（primary）。浅色模式下主要用于高亮内容、分节标题、强调色等。
深色模式下的主色（primary）。主要用于高亮内容、分节标题、强调色等。
重要按钮的主色
浅色/深色模式的背景色
浅色模式背景色（Hex）
深色模式背景色（Hex）
顶部栏（topbar）链接数组，由 `name` 与 `url` 组成
按钮名称。
示例：`Contact us`
点击按钮后的跳转 URL。示例：`https://mintlify.com/docs`
`link`：显示一个按钮；`github`：根据提供的仓库 URL 展示 GitHub 信息（含 star 数）。
若为 `link`：按钮跳转到的 URL。
若为 `github`：用于加载 GitHub 信息的仓库链接。
按钮文字。仅当 `type` 为 `link` 时必填。
版本名称数组。仅当你希望在导航栏中用下拉框展示多版本文档时使用。
anchors 数组，包含 `icon`、`color`、`url` 等配置。
用于展示该 anchor 的 [Font Awesome](https://fontawesome.com/search?q=heart) icon。
示例：`comments`
anchor 的显示名称（label）。
示例：`Community`
URL 前缀，用于标识哪些页面归入该 anchor。一般对应你放置页面的文件夹名称。
anchor icon 背景色（Hex）。也可传入包含 `from` 和 `to`（均为 Hex）的对象来实现渐变。
若你希望在选择特定文档版本前隐藏该 anchor，可使用此字段。
传 `true` 则默认隐藏该 anchor，直到你使用直链把用户带到该 anchor 下的页面。
可选值之一："brands"、"duotone"、"light"、"sharp-solid"、"solid"、"thin"
覆盖最顶部 anchor 的默认配置。
最顶部 anchor 的名称
Font Awesome icon。
可选值之一："brands"、"duotone"、"light"、"sharp-solid"、"solid"、"thin"
导航 tabs 数组。
tab 的显示名称（label）。
URL 前缀，用于标识哪些页面归入该 tab。一般对应你放置页面的文件夹名称。
API 相关配置。更多信息可参考 [Mintlify API Playground 概览](https://www.mintlify.com/docs/api-playground/overview)。
所有 API endpoints 的 base URL。若 `baseUrl` 为数组，则会启用多个可切换的 base URL 选项。
所有 API endpoints 使用的鉴权策略。
API playground 中使用的鉴权参数名称。
若 method 为 `basic`，格式应为 `[usernameName]:[passwordName]`
设计为鉴权输入框前缀的默认值。
例如：若 `inputPrefix` 为 `AuthKey`，则鉴权输入框会默认以 `AuthKey` 作为前缀。
API playground 配置
playground 的展示模式：显示（show）、隐藏（hide）、或仅展示 endpoint 但不提供交互的简化模式（simple）。
更多说明见：[Mintlify API Playground 概览](https://www.mintlify.com/docs/api-playground/overview)
启用该开关后，OpenAPI 页面中的 key 顺序会与 OpenAPI 文件中定义的顺序一致。
This behavior will soon be enabled by default, at which point this field will be deprecated.
指向 OpenAPI 文件的 URL（字符串）或 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`
反馈（feedback）按钮相关配置
启用按钮，允许用户通过 Pull Request 提交修改建议
启用按钮，允许用户针对文档提出 Issue
自定义深色模式切换（dark mode toggle）。
为新用户设置默认展示 light 或 dark 模式。未设置时，默认跟随用户操作系统。
设为 `true` 可隐藏 light/dark 模式切换。你也可以将 `isHidden` 与 `default` 组合使用，强制文档只使用 light 或 dark 模式。例如：
```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)。