SuperAPI AI 工具集

mintlify

编程与开发

查看项目

更新于 10-16 03:06

技能介绍

用途:Mintlify 将 MDX 文件转换为文档站点,适合创建与维护产品文档、API 参考等文档网站。配置集中写在 docs.json,内容用带 YAML frontmatter 的 MDX 编写,优先使用内置组件。

主要能力:站点级配置(导航结构、主题、颜色、链接、API 与规范)位于 docs/docs.json;导航可按 Groups、Tabs、Anchors、Dropdowns、Products、Versions、Languages 等模式组织;支持 OpenAPI 自动生成 API 页面,也可手写端点或用混合方式;提供 Accordion、Expandable、Tabs、Card、Steps、CodeGroup、ParamField、ResponseField 及 Note/Info/Tip/Warning/Check 等组件;支持 snippets 复用内容;通过 custom.css 做组件样式与布局微调;深色模式默认启用。

使用方式:安装 CLI 用 npm i -g mint;本地预览用 mint dev(localhost:3000);检查内部链接用 mint broken-links;检查无障碍问题用 mint a11y;重命名或移动文件并更新引用用 mint rename;验证文档构建用 mint validate。每个页面 frontmatter 至少需要 title,建议包含 description,可选 sidebarTitle、icon、tag、mode、keywords 等。新建页面必须加入 docs.json 导航,否则不会出现在侧边栏。内部链接使用根相对路径且不带扩展名,图片存放于 /images。推送变更到已连接的 Git 仓库后自动部署。

适用场景:需要结构化文档站点、API 参考自动生成、导航与主题定制、内容复用及链接与构建校验的文档维护工作。

限制:自定义域名、预览部署设置和 DNS 配置需在仪表盘人工完成;迁移到 Mintlify 时若来自 ReadMe 或 Docusaurus 可用 @mintlify/scraping CLI,其他平台需手动转换为 MDX;mint.json 已弃用,只能用 docs.json;未加入导航的页面为隐藏页。