用途:Mintlify 将 MDX 文件转换为文档站点,适合构建和维护文档站,包括创建页面、配置导航、添加组件与 API 参考。
主要能力:站点级配置写在 docs.json(导航、主题、颜色、链接、API 与规格);内容用带 YAML frontmatter 的 MDX 编写,优先使用内置组件而非自定义组件。支持 OpenAPI 规格自动生成端点页面,也支持手动编写端点页。
使用方式:安装 CLI 用 npm i -g mint;本地预览用 mint dev(localhost:3000);检查内部链接用 mint broken-links;检查无障碍问题用 mint a11y;重命名或移动文件并更新引用用 mint rename;验证构建用 mint validate。每个页面 frontmatter 至少需要 title,建议加 description。内部链接使用根相对路径且不带扩展名,如 /getting-started/quickstart;图片放在 /images 并以 /images/example.png 引用。新建页面必须加入 docs.json 导航,否则不会出现在侧边栏。
适用场景:需要结构化文档站、API 参考、多版本或多语言文档的团队。
限制:mint.json 已弃用,只能使用 docs.json;自定义域名、预览部署设置和 DNS 配置需在仪表盘人工完成;组件导入、frontmatter 与代码块语言标签等细节需遵守约定。资料未提供收费与价格信息。