SuperAPI AI 工具集

mintlify

写作与研究

查看项目

更新于 10-15 20:13

技能介绍

用途:为使用 Mintlify 构建文档站点提供参考,适用于创建页面、配置 docs.json、添加组件、设置导航或搭建 API 文档等任务。

主要能力:Mintlify 使用带 YAML frontmatter 的 MDX 文件(.mdx 或 .md)。站点配置由 docs.json 定义导航、主题、颜色等。页面 frontmatter 常用字段包括 title(必填)、description、sidebarTitle、icon、tag、hidden、mode、keywords、api、openapi。组件涵盖 callouts(Note、Info、Tip、Warning、Check、Danger)、Steps、Tabs、CodeGroup、Cards、Columns、AccordionGroup 等。

使用方式:先阅读项目的 docs.json,再搜索已有内容避免重复,并参考 2-3 个相似页面匹配风格。新页面需加入 docs.json 导航,否则不会出现在侧边栏。内部链接使用根相对路径且不带扩展名,如 /getting-started/quickstart,不使用相对路径或绝对 URL。图片放在 images/ 目录并以根相对路径引用,且必须有描述性 alt 文本。

CLI 命令:npm i -g mint 安装;mint dev 本地预览 localhost:3000;mint broken-links 检查内部链接;mint a11y 检查无障碍问题;mint validate 验证构建;mint upgrade 从 mint.json 升级到 docs.json。

写作规范:使用第二人称、主动语态,标题用句子式大小写,代码块必须有语言标签,避免营销语言与 emoji。

限制:详细主题需查阅 reference/ 目录下的 components.md、configuration.md、navigation.md、api-docs.md。具体收费、价格与平台支持信息暂未提供。