如何使用编辑器
Mintlify 编辑器的分步演练:创建分支、编辑页面、分享预览部署以供审阅,然后发布你的更改。
本教程将引导你使用编辑器完成一次完整的内容更新。你将创建分支、进行更改、分享预览以供审阅,然后发布你的更改。
创建分支
分支是你内容的临时副本。你可以在其中进行更改,而不会影响你的线上站点。你可以把分支合并到线上站点,也可以在决定不进行更改时安全地丢弃它。
在分支上工作可以让你的编辑与线上站点保持隔离,直到你准备好与用户分享内容为止。
- 在编辑器工具栏中,点击分支名称(通常为
main,带有 Live 徽章)。如果看不到它,请显示分支选择器。 - 在 Find a branch 中输入描述你更改的标题,例如
Update quickstart。 - 点击 New branch。
编辑器会切换到你的新分支。你所做的任何更改都只在该分支上,并在你工作时自动提交到该分支。只有在你完成发布流程后,它们才会出现在你的线上站点上。
进行更改
编辑现有页面或创建新页面。
编辑页面:点击导航侧边栏中的页面名称将其打开。直接在编辑器中输入以添加内容。按 / 可插入组件、图片或其他内容。
创建页面:点击你想要添加页面的导航分组旁边的 加号按钮,然后点击 New page。为页面输入标题。编辑器会以该标题命名文件。
发布你的分支
首次编辑分支时,编辑器会为其打开一个 pull request。pull request 是把你的更改合并到构建你线上站点的分支的提议。只有在 pull request 合并之后,你的更改才会上线。
准备好接受审阅后,可以从发布菜单请求审阅。
- 点击工具栏中的 Publish 以打开发布菜单。
- 可选:点击列表中任意已更改的文件,查看并将你的编辑与已发布版本进行对比。
- 点击 Request review。
Mintlify 会为你的 pull request 构建预览部署:一个临时链接,你的更改在其中的渲染效果与线上站点上完全一致。你可以在 Mintlify 机器人的 pull request 评论中找到该 URL,并将其分享给你的审阅者。
让你的 pull request 获得批准
将 pull request 分享给你的团队。若要打开它,请点击发布菜单中的 View request。审阅者可以在 GitHub、GitLab 或 Bitbucket 中打开 pull request,留下评论、请求更改或批准它。
如果审阅者请求更改,请在同一分支上的编辑器中进行编辑。你的更新会自动提交到现有的 pull request,无需创建新的。
当所有必需的审阅者都批准后,pull request 即可合并。
合并并发布
在 pull request 获得批准后,点击工具栏中的 Publish 重新打开发布菜单。菜单现在会显示 pull request 状态以及合并选项。
点击 Merge and publish。如果 Mintlify 托管你的仓库并且不要求审批,该按钮会显示为 Publish。编辑器会合并 pull request,并把你切换回 deployment branch。Mintlify 会构建并部署你的更改。你的线上站点会在大约 30 秒到几分钟内更新。