快速开始

在入职流程中，我们在您的 Github 上创建了一个包含文档内容的仓库。您可以在我们的 控制台中找到这个仓库。要在本地克隆该仓库， 请在终端中按照这些说明 进行操作。

预览功能可以帮助您确保更改的效果符合预期。我们构建了一个命令行界面来在本地渲染这些更改。

1. 安装 Mintlify CLI 以在本地预览文档更改， 使用以下命令：npm i -g mintlify
2. 在文档根目录（即 docs.json 所在位置）运行以下命令：mintlify dev

我们的 Github 应用会自动将您的更改部署到文档站点，因此您无需自己管理部署。 您可以在控制台中找到安装链接。 一旦机器人安装成功，仓库的提交哈希值旁边就会出现一个对勾标记。

提交并将更改推送到 Git 以更新您的文档站点。如果推送后没有看到 Github 应用成功部署您的更改， 您也可以通过我们的控制台手动更新文档。