Skip to main content
每个 Mintlify 站点都需要一个包含核心配置的 docs.json 文件。下面了解各字段属性

Properties

string
required
项目名称。用于全局标题显示。示例:mintlify
Navigation[]
required
导航分组数组,包含各分组下的所有页面。
logo 路径,或包含亮色/暗色模式 logo 路径的对象。
string
站点 favicon 图标路径
Colors
站点主题的十六进制颜色配置
顶部栏链接的数组,包含 nameurl
Call to Action
string[]
版本名称数组。若需在导航栏显示版本下拉,请使用此字段。
Anchor[]
锚点数组,包含 iconcolorurl
Object
覆盖最顶层锚点的默认配置。
Tabs[]
导航选项卡数组。
API
API 相关配置。关于 API 页面详见API 组件
string | string[]
指向 OpenAPI 文件的 URL 或相对路径(单个字符串或字符串数组)。示例:
社媒账号对象,key 为平台名、value 为该平台的账号 URL。示例:
Feedback
启用反馈按钮的配置。
ModeToggle
自定义明暗模式切换。
string
在每个页面后方显示的背景图片。示例可参考 InfisicalFRPC