Mintlify文档站搭建与维护
输入现有文档项目或 API 规范,按 Mintlify 结构编写 MDX 页面、调整导航配置并检查链接,产出可预览和部署的文档站点。
功能与用途
用于创建和维护 Mintlify 文档站,适合从空项目搭建站点,也可基于已有项目补充或修改文档页面、导航和站点配置。你可以提供项目中的 docs.json、相关页面内容或 OpenAPI 规范,获得符合现有站点结构的 MDX 页面、配置更新和验证建议。新页面需要加入导航才能显示在侧边栏;本地预览和 CLI 检查需要安装 Node.js,部署通常通过连接的 Git 仓库完成。
适用场景
- 搭建产品文档站:整理项目结构与内容需求,创建 MDX 页面并配置 docs.json 导航。
- 补充 API 参考文档:提供 OpenAPI 规范或接口信息,配置自动生成页面或编写手动接口页。
- 维护已有文档:检查相关页面和站点结构,更新内容、组件、链接或导航配置。
- 迁移旧版帮助中心:说明原文档平台与目标结构,将现有内容转换为 Mintlify 页面。
适用人群
- 负责产品文档的技术写作者
- 维护开发者文档的工程师
- 需要发布 API 文档的团队
使用步骤
- 说明要创建、修改或迁移的文档内容。
- 提供现有页面、docs.json 或 API 规范。
- 确认页面结构、导航位置和读者目标。
- 生成或修改 MDX 与配置文件。
- 使用 Mintlify CLI 预览并检查链接和配置。
开始使用
将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。
技术信息
- 分类
- 知识
- 适用工具
- Codex、Claude Code、OpenClaw、Hermes Agent、国内 Agent
- 使用难度
- 进阶
- 版本
- main
- 最近更新
- 2026-11-03
- 文件数
- 3
- 安装包大小
- 自动生成 ZIP
- 安全检查
- 基础检查通过
Build and maintain documentation sites with Mintlify. Use when creating docs pages, configuring navigation, adding components, or setting up API references.