AI自动化文档生成工具-Mintlify简介

共计 2780 个字符，预计需要花费 7 分钟才能阅读完成。

摘要生成中

AI 生成，仅供参考

Mintlify 简介
Mintlify 是面向开发者和团队的新一代文档平台，主打「AI 原生、开箱即用、为开发者而建」。内容用 docs-as-code 方式管理（Markdown/MDX + Git），站点通过 docs.json 配置，支持从 OpenAPI 自动生成 API 文档、丰富组件、以及内置的 AI 阅读 / 写作 / 发现能力。

官网文档地址：https://www.mintlify.com/docs

产品定位与特点
AI 原生：文档既给人看，也方便 AI 读、写和检索；支持站内问答、Agent 写文档、llms.txt/MCP 等，便于被大模型和工具使用。

开箱即用：连接 Git 仓库即可自动部署，自带主题、导航、搜索、API Playground，无需从零搭前端。

面向开发者：支持 OpenAPI/AsyncAPI、代码示例、多语言 / 多 SDK、API 调试等，适合 API 文档、产品文档和知识库。

文档索引：官方把文档索引放在 https://www.mintlify.com/docs/llms.txt，便于 AI 或脚本一次性发现所有文档页面。

内容与站点结构
技术栈与格式
内容格式：以 MDX 为主（Markdown + JSX），每页有 YAML frontmatter（如 title、description）。

站点配置：根目录 docs.json 配置整站：导航、主题、颜色、API 规范路径、集成等；完整 schema 见 mintlify.com/docs.json。

导航：支持多种结构（Groups、Tabs、Anchors、Dropdowns、Products、Versions、Languages），在 docs.json 的 navigation 里配置。

组件库
Mintlify 提供大量内置组件，用于排版和交互，例如：

类型 组件示例 用途
结构 / 折叠、可展开 / 收起的区块
强调 / 提示、、、说明、注意、建议、警告
步骤、分步操作说明
多选一 多语言 / 多版本示例切换
布局、卡片、多列布局
代码、多段代码、可展开代码块
API 文档、请求 / 响应参数展示
更多见 Components 总览 及各子页（如 Accordions）。

API 文档能力
OpenAPI：在 docs.json 中配置 openapi 指向规范文件，可自动生成 API 页面；支持复杂类型（oneOf/anyOf/allOf）、多响应、可见性控制等。

AsyncAPI：支持 WebSocket 等异步 API 文档。

Playground：在文档内直接调试接口；可配合 SDK 示例（如 Speakeasy、Stainless）。

手动 API 页：用 MDX + api: “METHOD /path” 等方式手写接口说明，与自动生成混合使用。

详见 OpenAPI 设置、Playground 概览。

AI 原生能力（阅读 / 写作 / 发现）
官方在 AI-native documentation 中把能力分为三块：

1. 阅读（Reading）
   站内助手（Assistant）：用户可在文档站内对话提问，助手基于文档内容回答并引用来源；也可通过 Assistant API 嵌入到自有应用。

支持接入 Slack Bot、Discord Bot 等，在对话中基于文档回答问题。

2. 写作（Writing）
   Agent：根据提示、PR、Slack 对话等生成文档变更并提交 PR，用于持续维护文档。

Workflows：按 schedule 或 push 等事件自动跑 Agent 任务，实现「代码 / 产品变更 → 自动更新文档」。

AGENTS.md / skill.md：配置 AI 行为与能力，便于 Cursor、Claude Code、Windsurf 等工具按规范写文档。

3. 发现（Discovering）
   llms.txt：站点提供 llms.txt 索引，方便 LLM 和爬虫发现全站页面。

Markdown 导出：页面可通过 URL 加 .md 等方式以 Markdown 形式暴露，便于 AI 消费。

MCP（Model Context Protocol）：提供 MCP 服务，让 AI 工具直接连接你的文档与 API，在 IDE 等环境中使用最新文档。

搜索：站内全文 + 语义搜索，404 时推荐相关页面，无需额外配置。

工作流：从创建到发布

1. 快速开始（Quickstart）
   打开 mintlify.com/start 完成引导：连接 GitHub、选择 / 创建文档仓库、安装 GitHub App。

站点会自动部署到 *.mintlify.app；也可先不连 GitHub，用 Mintlify 提供的私有仓库，之后再迁到自己的仓库。

详细步骤见 Quickstart。

2. 本地开发与 CLI
   安装：npm i -g mint 或 pnpm add -g mint（需 Node.js v20.17+）。

本地预览：在文档目录执行 mint dev，在 http://localhost:3000 查看效果。

质量检查：CLI 支持 mint broken-links、mint a11y、mint validate 等，用于检查链接、无障碍、配置与构建。

详见 Install the CLI。

3. Web 编辑器
   在 Dashboard 的 Web Editor 中在线编辑页面、管理导航、上传媒体。
   支持实时预览、分支、评论、建议（Suggestions）、发布，并与 Git 同步；适合非开发同事参与文档维护。
   见 Web editor overview。
4. 部署与集成
   自动部署：推送 Git 后自动构建发布；支持 Preview 部署（PR 专属预览链接）。
   自托管 / 子路径：支持 Vercel、Cloudflare、Route53+CloudFront 等，可在主站子路径（如 /docs）挂载。
   仓库：支持 GitHub、GitLab、GitHub Enterprise；支持 Monorepo 指定文档目录。
   分析 / 客服：可接入 Google Analytics、Segment、Intercom、Front 等。
   其他重要能力
   多语言（i18n）：见 Internationalization。
   自定义：主题、字体、自定义域名、自定义 404、React 组件、自定义脚本 /CSS，见 Themes、Global settings。
   权限与安全：SSO、角色（Admin/Editor/Viewer）、部署权限、审计日志、安全联系邮箱等，见 Dashboard 相关文档。
   迁移：从 Docusaurus、ReadMe 等迁移 的说明与工具。
   如何进一步查阅
   全站文档索引（面向 AI/ 爬虫）：https://www.mintlify.com/docs/llms.txt — 可一次性拿到所有文档链接与简介。
   人类浏览入口：https://www.mintlify.com/docs — 按分类浏览 Introduction、Quickstart、CLI、Components、API Playground、Deploy、Guides 等。
   配置与规范：docs.json 全局配置、配置 schema。
   参考文献
   https://www.mintlify.com/docs