mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
0aa4dcab4a
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
69 lines
4.4 KiB
Plaintext
69 lines
4.4 KiB
Plaintext
---
|
||
title: "如何使用编辑器"
|
||
description: "Mintlify 编辑器的分步演练：创建分支、编辑页面、分享预览部署以供审查，然后发布你的更改。"
|
||
keywords: ["编辑器", "教程", "分支", "发布"]
|
||
---
|
||
|
||
本教程将引导你使用编辑器完成一次完整的内容更新。你将创建一个分支、进行更改、分享预览以供审查，然后发布你的更改。
|
||
|
||
<Steps>
|
||
<Step title="Create a branch">
|
||
分支是你内容的临时副本。这是你在不影响线上站点的情况下进行更改的地方。你可以将分支合并到线上站点，或在选择不进行更改时安全地丢弃它。
|
||
|
||
在分支上工作可以让你的编辑与线上站点保持隔离，直到你准备好与用户分享内容为止。
|
||
|
||
1. 在编辑器工具栏中，点击分支名称（通常为 `main`）。
|
||
<Frame>
|
||
<img src="/images/editor/create-branch-light.png" alt="编辑器工具栏中突出显示的分支名称。" className="block dark:hidden" />
|
||
<img src="/images/editor/create-branch-dark.png" alt="编辑器工具栏中突出显示的分支名称。" className="hidden dark:block" />
|
||
</Frame>
|
||
1. 点击 **Create new branch**。
|
||
1. 输入一个描述你的更改的名称，例如 `update-quickstart`。
|
||
1. 点击 **Create branch**。
|
||
|
||
编辑器会切换到你的新分支。你所做的任何更改都只在该分支上。只有在你完成发布流程后，它们才会出现在你的线上站点上。
|
||
</Step>
|
||
<Step title="Make your changes">
|
||
编辑现有页面或创建新页面。
|
||
|
||
**编辑页面**：点击导航侧边栏中的页面名称将其打开。直接在编辑器中输入以添加内容。按下 <kbd>/</kbd> 可插入组件、图片或其他内容。
|
||
|
||
**创建页面**：点击你想要添加页面的导航分组旁边的 <Icon icon="plus" /> 加号按钮，然后点击 **Add a page** 并输入文件名。
|
||
|
||
<Frame>
|
||
<img src="/images/editor/add-page-light.png" alt="在编辑器中某个分组旁打开的添加页面菜单。" className="block dark:hidden" />
|
||
<img src="/images/editor/add-page-dark.png" alt="在编辑器中某个分组旁打开的添加页面菜单。" className="hidden dark:block" />
|
||
</Frame>
|
||
|
||
</Step>
|
||
<Step title="Publish your branch">
|
||
当你准备好接受审查时，从你的分支创建一个拉取请求。拉取请求是一个将你的更改合并到构建线上站点的分支的提议。只有在有人批准并合并拉取请求后，你的更改才会上线。
|
||
|
||
1. 点击工具栏中的 **Publish** 以打开发布菜单。
|
||
<Frame>
|
||
<img src="/images/editor/publish-menu-light.png" alt="在编辑器工具栏中打开的发布菜单。" className="block dark:hidden" />
|
||
<img src="/images/editor/publish-menu-dark.png" alt="在编辑器工具栏中打开的发布菜单。" className="hidden dark:block" />
|
||
</Frame>
|
||
1. 可选：点击列表中任意已更改的文件，查看并将你的编辑与已发布版本进行对比。
|
||
1. 点击 **Create pull request**。添加标题和描述，然后点击 **Publish pull request**。
|
||
|
||
<Note>
|
||
你也可以点击 **Save in branch**，先提交你的更改而不立即打开拉取请求。如果你想在请求审查之前继续编辑，这会很有用。
|
||
</Note>
|
||
|
||
创建拉取请求后，预览部署会自动构建。发布菜单会显示预览 URL——一个临时链接，你的更改会在那里以线上站点上的样子完全呈现。将此 URL 分享给你的审查者。
|
||
</Step>
|
||
<Step title="Get your pull request approved">
|
||
将拉取请求分享给你的团队。审查者可以在 GitHub、GitLab 或 Bitbucket 中打开拉取请求，留下评论、请求更改或批准它。
|
||
|
||
如果审查者请求更改，请在同一分支上的编辑器中进行编辑。你的更新会自动推送到现有的拉取请求。你不需要创建新的。
|
||
|
||
当所有必需的审查者都批准后，拉取请求即可合并。
|
||
</Step>
|
||
<Step title="Merge and publish">
|
||
在拉取请求获得批准后，点击工具栏中的 **Publish** 以重新打开发布菜单。该菜单现在会显示拉取请求的状态以及合并选项。
|
||
|
||
点击 **Merge and publish**。编辑器会合并拉取请求，并将你切换回部署用分支。Mintlify 会构建并部署你的更改。你的线上站点会在大约 30 秒到几分钟内更新。
|
||
</Step>
|
||
</Steps>
|