你的网站 URL 会立即生效。在设置文档站点期间，请使用该 URL 进行测试并与团队分享。
### 安装 GitHub 应用
Mintlify 提供了一个 GitHub 应用，可在你将更改推送到存储库时自动触发部署。
按照入门检查清单或在控制台中的指引安装 GitHub 应用。
1. 在 Mintlify 控制台中进入 **Settings**。
2. 在侧边栏选择 **GitHub App**。
3. 选择 **Install GitHub App**。这将在新标签页中打开 GitHub 应用安装页面。
4. 选择要安装该应用的组织或用户账户。
5. 选择你要连接的存储库。
## 编辑工作流程
Mintlify 提供两种用于创建和维护文档的工作流程：
## 基于代码的工作流
基于代码的工作流可与您现有的开发环境和 Git 仓库集成。该工作流最适合希望将文档与代码并行管理的技术团队。
### 安装命令行界面（CLI）
要在本地处理文档，请在终端运行以下命令，安装名为 [mint](https://www.npmjs.com/package/mint) 的命令行界面（CLI）：
### 编辑文档
完成环境配置后，您即可开始编辑文档文件。例如，更新介绍页的标题：
1. 打开您在入门引导过程中创建的存储库。
2. 打开 `index.mdx`，定位到文件顶部：
```mdx index.mdx theme={null}
---
title: "介绍"
description: "这是文档的介绍"
---
```
3. 将 `title` 字段更新为 `"Hello World"`。
```mdx index.mdx {2} theme={null}
---
title: "你好世界"
description: "这是文档的介绍"
---
```
### 预览更改
要在本地预览更改，请运行以下命令：
```bash theme={null}
mint dev
```
你的预览将可在 `localhost:3000` 查看。
### 推送更改
当你准备发布更改时，将其推送到你的存储库。
Mintlify 会自动检测更改，构建你的文档，并将更新部署到你的网站。你可以在 GitHub 存储库的提交历史或 [控制台](https://dashboard.mintlify.com) 中查看部署状态。
部署完成后，你的最新更新将可通过 `
## Web editor 工作流
Web editor 工作流提供 WYSIWYG（所见即所得）界面，用于创建和编辑文档。该工作流最适合希望直接在网页浏览器中工作且无需额外本地开发工具的用户。
### 访问网页编辑器
1. 登录你的[控制台](https://dashboard.mintlify.com)。
2. 在左侧边栏选择 **Editor**。
### 编辑文档
在 Web 编辑器中，你可以通过侧边栏浏览文档文件。现在更新介绍页：
在文件资源管理器中找到并选择 `index.mdx`。
然后在编辑器中，将 title 字段更新为 “Hello World”。
### 发布更改
当你对编辑结果满意时，点击右上角的 **Publish** 按钮。你的更改会立即部署到文档站点。
## 添加自定义域名
虽然 `
输入你的 domain（例如 `docs.yourcompany.com`），并按照页面上的指引在域名服务商处配置 DNS（域名系统）设置。
## 后续步骤
恭喜！您已成功使用 Mintlify 部署文档站点。以下是提升文档的推荐后续步骤：
## 疑难解答
如果在设置过程中遇到问题，请查看以下常见解决方案：