Mintlify怎么用 AI文档网站生成工具教程

Mintlify是一个AI文档网站生成工具，可以从代码仓库自动生成产品文档，开发者喜欢用。下面从创建项目开始，带你把仓库接入、整理页面、预览并发布。先准备一个 GitHub 账号，以及已有的产品说明或 API 代码；首次使用也可以从示例模板起步。

步骤一：注册并创建文档项目

打开 Mintlify 官网，点击 Get started 或 Sign up，用 Google 账号注册并进入控制台。按页面提示新建文档项目；如果出现模板选项，选择 Starter Kit，先用现成页面熟悉结构。创建后记下项目名称，进入项目总览页，确认能看到文档站点的预览入口，再继续连接代码仓库。

步骤二：准备 GitHub 文档仓库

登录 GitHub，新建一个专门放文档的仓库，或选已有仓库。若刚开始，复制 Mintlify Starter Kit 模板最省事：在模板仓库页面点击 Use this template，再创建自己的仓库。模板里通常有首页、指南、API 示例和 docs.json 配置；这些文件就是后续改内容、改导航的基础。

步骤三：把仓库连接到 Mintlify

回到 Mintlify 控制台，选择 Connect repository 或连接 GitHub，按授权页提示允许应用访问目标仓库。随后从列表中选刚才创建的文档仓库，并确认默认分支，例如 main。连接完成后检查项目设置里的仓库名称和分支是否正确；如果仓库没显示，先确认 GitHub 授权范围包含它。

步骤四：整理首页和导航

在仓库文件列表中打开 index.mdx，替换示例标题、简介和快速入口，写清产品用途、适用对象与第一步操作。再打开 docs.json，找到 navigation 区域，把模板菜单项改成自己的章节名称和页面路径。保存后提交变更；路径要和实际文件一致，否则菜单点击后容易出现空白页或 404。

步骤五：用 AI 起草功能文档

先挑一个具体功能，例如登录、创建项目或调用接口，把对应代码、参数和预期结果作为依据。进入 Mintlify 的编辑或 AI 写作入口，输入明确指令：要求按前置条件、操作步骤、示例和常见错误组织内容。生成后逐段核对字段名、命令和返回值，再将确认过的文字放进对应 MDX 页面。

步骤六：编写 API 页面并加示例

在仓库中新建 API 说明页面，先写接口用途、请求方法、路径、认证方式和必填参数，再添加请求与响应示例。若项目已有 OpenAPI 文件，可按 Mintlify 当前支持的导入或引用方式接入，避免手动抄写字段。发布前用真实接口对照示例，尤其检查参数类型、错误码和鉴权头，AI 草稿不能代替验证。

步骤七：本地预览并修正问题

想在发布前检查页面，可在本地安装 Node.js，然后打开终端进入文档仓库根目录，执行 npm i -g mint 安装 CLI，再运行 mint dev。浏览器打开终端显示的本地地址，逐页检查菜单、链接、代码块和手机屏幕效果。页面报错时先确认当前目录有 docs.json，修正后刷新预览。

步骤八：提交并发布网站

检查完成后，把修改提交并推送到连接的默认分支。首次部署时按控制台提示设置站点地址或自定义域名；之后推送更新，Mintlify 会根据项目连接配置构建并部署。打开线上网址检查首页和关键页面，确认图片、链接与导航正常；若没更新，查看部署状态和构建日志。

步骤九：持续维护文档内容