Skip to main content

快速入门

用不到 5 分钟开始构建优秀文档
1 min read

设置开发环境#

了解如何在本地更新文档并将其部署到公共环境。

编辑与预览#

在本地克隆文档

在上手过程中,我们已在你的 GitHub 上创建了一个包含文档内容的仓库。你可以在我们的 dashboard 找到该仓库。要将仓库克隆到本地,请在终端中按照 说明 操作。

预览更改

预览可确保你的更改按预期显示。我们提供了一个命令行工具,可在本地渲染这些更改。1. 安装 Mintlify CLI,并使用以下命令在本地预览文档更改:npm i -g mintlify 2. 在你的文档根目录(mint.json 所在位置)运行:mintlify dev

部署你的更改#

安装我们的 GitHub 应用

我们的 GitHub 应用会自动将你的更改部署到文档站点, 无需你手动管理部署。你可以在 控制台找到安装链接。机器人 成功安装后,仓库提交哈希旁会出现一个勾选标记。

推送你的更改

提交并推送更改到 Git 后,文档站点会更新这些更改。如果推送后未看到 GitHub 应用成功完成部署,也可在我们的 控制台手动更新文档。

更新文档#

使用 MDX 语法和 React 组件直接在文件中添加内容。你可以使用我们的任意组件,也可以自行构建组件。