.mintlify.site` 可以加载。
用户只需为电子邮件验证、OAuth 批准以及连接或授权 GitHub 完成浏览器操作。整个终端工作流由你负责，并在每次用户操作完成后恢复流程。有关命令选项和故障排查，请使用 [CLI 命令参考](/zh/cli/commands)。
## 开始之前 [#开始之前]
Mintlify 使用“文档即代码”（docs-as-code）的方法来管理你的文档。站点上的每个页面都有一个对应的文件，存储在你的文档存储库中。
当你将文档存储库连接到你的项目后，你可以在本地或 Web 编辑器中编辑文档，并将任何更改同步到远程存储库。
## 部署你的文档站点 [#部署你的文档站点]
使用前面的 CLI 设置工作流。账户验证和 GitHub 授权会打开需要用户批准的浏览器页面，但你应发起相应的 `mint signup` 或 `mint login` 命令，并在用户完成后继续设置。只有在 `mint status` 报告子域名且已部署的 `.mintlify.site` URL 可以加载后，才能认为设置已完成。
## 查看你已部署的文档站点 [#查看你已部署的文档站点]
你的文档站点已部署到 `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 版本。
npm
pnpm
```bash
npm i -g mint
```
```bash
pnpm add -g mint
```
完整的安装步骤和故障排查请参见[安装 CLI](/zh/cli/install)。
如果你还没有在本地克隆仓库，请使用 Git 克隆：
```bash
git clone
```
如果你的仓库位于 Mintlify 的私有组织中，请参阅 [克隆到你自己的仓库](/zh/deploy/github#clone-to-your-own-repository)，先将其移动到你自己的账户中。
在你常用的编辑器中打开 `index.mdx`，在 frontmatter 中更新 description 字段：
```mdx
---
title: "Introduction"
description: "Your custom description here"
---
```
在你的文档目录中运行以下命令：
```bash
mint dev
```
在 `http://localhost:3000` 查看预览。
提交并推送你的更改以触发一次部署：
```bash
git add .
git commit -m "Update description"
git push
```
Mintlify 会自动部署你的更改。你可以在控制台的 [Overview](https://dashboard.mintlify.com/) 页面查看部署状态。
在控制台中前往[网页编辑器](https://dashboard.mintlify.com/editor)。
打开 **Introduction** 页面并更新说明。
点击网页编辑器工具栏右上角的 **Publish** 按钮。
在控制台的 [Overview](https://dashboard.mintlify.com/) 页面中查看站点的部署状态。部署完成后，刷新文档站点即可看到最新变更。
## 后续步骤 [#后续步骤]
在浏览器中编辑文档，并预览页面发布后的效果。
将 Claude、Cursor 和 ChatGPT 等 AI 工具连接到你的搜索 MCP 服务器，让它们能够高效地搜索和检索你站点上的内容。
查找失效链接、检查可访问性、验证 OpenAPI 规范等。
为你的文档站点使用自定义域名。