全局设置

组的名称。

示例: Settings

作为页面的 markdown 文件的相对路径。

示例: ["customization", "page"]

浅色模式下的 logo 路径

深色模式下的 logo 路径

点击 logo 时链接到的位置

主要颜色。在浅色模式下最常用于突出显示的内容、章节标题、强调等

深色模式的主要颜色。在深色模式下最常用于突出显示的内容、章节标题、强调等

重要按钮的主要颜色

浅色和深色模式下的背景颜色

按钮的名称。

示例: 联系我们

点击按钮后的 url。示例: https://mintlify.com/docs

link 显示一个按钮。GitHub 显示在提供的 url 处的仓库信息, 包括 GitHub stars 数量。

如果是 link: 按钮链接到的位置。

如果是 github: 加载 GitHub 信息的仓库链接。

按钮内的文本。仅当 type 为 link 时需要。

用于展示锚点的 Font Awesome 图标。

示例: comments

锚点标签的名称。

示例: 社区

标记哪些页面属于锚点的 URL 开头。通常, 这是您放置页面的文件夹名称。

锚点图标背景的十六进制颜色。如果传递一个包含 from 和 to 属性的对象（每个属性都是一个十六进制颜色）, 也可以是渐变色。

如果您想在选择正确的文档版本之前隐藏锚点, 则使用此选项。

如果您想隐藏锚点, 直到您直接链接到其中的文档, 则传递 true。

以下之一: “brands”、“duotone”、“light”、“sharp-solid”、“solid” 或 “thin”

最顶层锚点的名称

Font Awesome 图标。

以下之一: “brands”、“duotone”、“light”、“sharp-solid”、“solid” 或 “thin”

标签标签的名称。

标记哪些页面属于标签的 URL 开头。通常, 这是您放置页面的文件夹名称。

所有 API 端点的基本 url。如果 baseUrl 是一个数组, 它将启用用户可以切换的多个基本 url 选项。

API playground 的配置

启用此标志可确保 OpenAPI 页面中的键顺序与 OpenAPI 文件中定义的键顺序匹配。

One of the following values website, facebook, x, discord, slack, github, linkedin, instagram, hacker-news

Example: x

The URL to the social platform.

Example: https://x.com/mintlify

Enables a button to allow users to suggest edits via pull requests

Enables a button to allow users to raise an issue about the documentation

Set if you always want to show light or dark mode for new users. When not set, we default to the same mode as the user’s operating system.

Set to true to hide the dark/light mode toggle. You can combine isHidden with default to force your docs to only use light or dark mode. For example:

"modeToggle": {
  "default": "dark",
  "isHidden": true
}