> ## Documentation Index
> Fetch the complete documentation index at: https://tomee-mintlify-a42fba9d.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# 快速入门
> 使用 Mintlify，在几分钟内部署文档站点，并通过网页编辑器或 Git 完成首次内容修改。
完成本指南后，你将拥有一个已上线的文档站点，可以开始对其进行自定义和更新。
使用 AI 智能体？
复制下面的提示词，让你的智能体为你搭建站点。它会指示你的智能体创建账号并部署站点，同时添加 Mintlify [skill](/zh/ai/skillmd) 和 [MCP 服务器](/zh/ai/model-context-protocol)，以便在你更新内容时获得更好的效果。
该提示词将快速入门拆分为智能体可以完成的一系列任务，并指示它在搭建过程中向你询问所需的任何信息。
让我的文档在已发布的 Mintlify 站点上正式上线。当你把在线 URL 给我并确认它能加载时，就算成功完成任务。当某个步骤需要我参与时，请清楚地告诉我——其他所有事情请你自己完成。如果这个提示词之前已经被粘贴过（例如在重启之后），请从上次中断的地方继续，而不是从头开始。如果你没有终端或命令执行权限，请告诉我改为在 [mintlify.com/start](https://mintlify.com/start) 按照手动步骤操作。以下所有步骤都需要执行命令，并且需要 Node.js v 20.17.0+（建议使用 LTS 版本）。
1. 询问我用于 Mintlify 站点的现有内容。它可以是本地文件夹或一个仓库。构建之前请先核对来源：把你正在读取的内容原样回显给我，并列出其顶层目录内容，以便我确认无误。如果你无法访问我指定的内容（私有仓库会返回 404，与不存在的仓库相同），请停下来询问我。绝对不要用其他来源替代。
2. 使用 `mint --version` 检查是否已安装 `mint`。如果没有，请用 `npm i -g mint`（或 `pnpm add -g mint`）进行安装。如果已经安装，请运行 `mint update` 而不是重新安装。
3. 运行 `mint status`。如果已经显示了一个组织，请跳到第 7 步。
4. 需要我参与：如果 `mint status` 显示我未登录，请直接问我是否已经拥有 Mintlify 账号。不要自己猜。
* 如果我有：运行 `mint login`。你需要我完成浏览器中的操作以及批准访问权限。
* 如果我没有：如果我还没提供，请向我索要名字、姓氏、公司和电子邮件——绝对不要自己编造。将 `mint signup --firstName [firstName] --lastName [lastName] --company [company] --email [email]` 作为后台任务运行，因为它会一直阻塞，直到我点击验证链接，而验证链接可能需要几分钟才会到达。
5. 需要我参与：我会查收邮件并点击验证链接。这会打开一个浏览器标签页，自动完成剩余的账号创建 / 登录流程。我必须批准 CLI，然后连接一个 GitHub 仓库，或者让 Mintlify 托管一个。请清楚地告诉我这一步由我来做，然后等我完成后再继续。
6. 再次运行 `mint status` 以确认组织和子域名现在都已存在。入门完成后，配置可能会稍有延迟——如果还看不到子域名，请等大约 10 秒并重试几次，然后再判断是否出了问题。
7. 需要我参与：请向我索要连接到 Mintlify 项目的仓库的 URL——`mint status` 不会显示它，所以你无法自己查到。拿到后请把它克隆下来。
8. 检查该仓库中的内容。如果我连接的是自己已有的文档仓库，我的内容已经在里面——请不要覆盖它。如果仓库是由 Mintlify 创建的，它包含初始模板内容——请用第 1 步中我的实际文档内容替换它。只有当我想要使用与仓库中不同的主题或模板时，才使用 `mint new [目录]`——先在本地生成，然后用其输出替换预置内容。
9. 使用 `mint dev` 进行预览，通常会在 `http://localhost:3000` 启动，除非该端口被占用。它在停止之前会一直阻塞，因此请作为后台任务运行。确认预览可以正常加载后，请先停止它再继续。
10. 提交并推送你的更改。Mintlify 会在推送时自动部署。
11. 需要我参与：如果我想使用自定义域名，请运行 `mint add-domain <域名>`。该命令会打印出我需要在域名服务商处添加的 DNS 记录。请把 DNS 记录告诉我，因为只有我可以在域名注册商处配置这些记录。请明确告诉我这是我必须完成的步骤。
12. 确认我的站点已上线：请获取 `https://<子域名>.mintlify.site`（通过 `mint status` 查找子域名）并确认可以加载。如果我在第 11 步添加了自定义域名，也请获取该域名并确认可以加载，然后再把这一步标记为完成——DNS 传播可能会延迟，所以在把一次获取失败当作错误之前，请多重试几次。
13. 为在这里持续工作做好准备：使用 `npx skills add https://mintlify.com/docs` 安装 [Mintlify skill](https://mintlify.com/docs/ai/skillmd.md)，然后在 `https://mcp.mintlify.com` 为你使用的具体工具注册 [admin MCP 服务器](https://mintlify.com/docs//ai/model-context-protocol.md)。例如，对于 Claude Code 使用 `claude mcp add --transport http mintlify https://mcp.mintlify.com`，或者获取 [https://mintlify.com/docs/ai/mintlify-mcp.md](https://mintlify.com/docs/ai/mintlify-mcp.md) 以查看针对 Claude、Cursor、Codex 或 ChatGPT 的说明。这一步请你自己完成——不要让我来运行这些命令。
14. 需要我参与：第一次调用 admin MCP 工具时会打开一个浏览器窗口进行 OAuth 登录。请在那里批准。大多数工具在会话中途不会加载新添加的 MCP 服务器——如果 Mintlify 相关工具没有出现，请告诉我重新启动你，然后我们从这里继续。
15. 如果任何命令以上文未涵盖的方式失败，请停下来告诉我确切的错误信息，而不是随便猜测或盲目重试。如果看起来问题出在 Mintlify 一侧而不是你所做的事情上，请查看 [https://status.mintlify.com](https://status.mintlify.com) 或引导我前往 [https://mintlify.com/docs/contact-support。](https://mintlify.com/docs/contact-support。)
## 开始之前
Mintlify 使用“文档即代码” (docs-as-code) 的方法来管理你的文档。站点上的每个页面都有一个对应的文件，存储在你的文档存储库中。
当你将文档存储库连接到你的项目后，你可以在本地或 Web 编辑器中编辑文档，并将任何更改同步到远程存储库。
## 部署你的文档站点
前往 [mintlify.com/start](https://mintlify.com/start) 并完成初始设置流程。在初始设置过程中，你会连接你的 GitHub 账户，为文档创建或选择一个存储库，并安装 GitHub 应用以启用自动部署。
完成初始设置后，你的文档站点会部署完成，并可通过你的 `.mintlify.site` URL 访问。
如果你想在不连接自己的存储库的情况下快速开始使用，可以在初始设置过程中跳过 Git 提供商连接。Mintlify 会在一个私有组织下为你创建一个私有存储库，并自动为你配置 GitHub 应用。
这样你可以立即使用 Web 编辑器。如果你之后想使用自己的存储库，请前往控制台中的 [Git Settings](https://app.mintlify.com/settings/deployment/git-settings)，通过 Git 设置向导迁移你的内容。详情请参阅[克隆到你自己的存储库](/zh/deploy/github#clone-to-your-own-repository)。
## 查看你已部署的网站
你的文档站点现在已部署在 `https://.mintlify.site`。
在 [控制台](https://dashboard.mintlify.com/) 的 **Overview** 页面中可以找到准确的 URL。
你的网站已经可以立即访问。使用这个 URL 进行测试并与团队分享。在面向正式用户分享之前，你可能希望先添加一个[自定义域名](/zh/customize/custom-domain)。
## 完成你的第一次修改
命令行界面 (CLI) 需要 [Node.js](https://nodejs.org/en) v20.17.0 或更高版本。为保证稳定性，建议使用 LTS 版本。
```bash npm theme={null}
npm i -g mint
```
```bash pnpm theme={null}
pnpm add -g mint
```
完整的安装步骤和故障排查请参见 [Install the CLI](/zh/cli/install)。
如果你还没有在本地克隆仓库，请使用 Git 克隆：
```bash theme={null}
git clone
```
如果你的仓库位于 Mintlify 的私有组织中，请参阅 [克隆到你自己的仓库](/zh/deploy/github#clone-to-your-own-repository)，先将其移动到你自己的账户中。
在你常用的编辑器中打开 `index.mdx`，在 frontmatter 中更新 description 字段：
```mdx theme={null}
---
title: "Introduction"
description: "Your custom description here"
---
```
在你的文档目录中运行以下命令：
```bash theme={null}
mint dev
```
在 `http://localhost:3000` 查看预览。
提交并推送你的更改以触发一次部署：
```bash theme={null}
git add .
git commit -m "Update description"
git push
```
Mintlify 会自动部署你的更改。你可以在控制台的 [Overview](https://dashboard.mintlify.com/) 页面查看部署状态。
在控制台中前往 [web editor](https://dashboard.mintlify.com/editor)。
打开 **Introduction** 页面并更新说明。
点击网页编辑器工具栏右上角的 **Publish** 按钮。
在控制台的 [Overview](https://dashboard.mintlify.com/) 页面中，你可以查看站点的部署状态。部署完成后，刷新你的文档站点即可看到最新的变更。
## 后续步骤
在浏览器中编辑文档，并预览页面发布后的效果。
查找失效链接、检查可访问性、验证 OpenAPI 规范等。
为你的文档站点使用自定义域名。