mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
1151ae6686
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
112 lines
5.1 KiB
Plaintext
112 lines
5.1 KiB
Plaintext
---
|
|
title: "草稿"
|
|
description: "在编辑器中创建隔离的草稿,在你请求审阅并发布之前,它们始终保持私密,而且你无需自己管理 Git 分支。"
|
|
keywords: ["editor", "draft", "publish", "autosave"]
|
|
---
|
|
|
|
在将更改发布到生产站点之前,使用草稿在编辑器中进行修改。草稿是一个隔离的工作区,你可以在其中撰写、预览和编辑内容。在你选择发布之前,你的更改仅在编辑器中可见。
|
|
|
|
草稿是在编辑器中进行更改的推荐方式。每个草稿都有一个由编辑器为你管理的 Git 分支和 pull request,让你无需切换分支或打开 pull request 即可开展工作。
|
|
|
|
<div id="how-drafts-work">
|
|
## 草稿的工作原理
|
|
</div>
|
|
|
|
**每次编辑都会自动保存。** 你在输入时,编辑器会将你的工作保存到 Mintlify 的服务器,然后在后台将更改提交到该草稿的分支。你的更改可以跨标签页、设备和网络中断持续保留。
|
|
|
|
**每个草稿都有自己的版本历史。** 编辑器会在你工作时提交更改,因此草稿会在其分支上累积一份变更历史。它还会保持一个打开的 pull request,反映草稿的当前状态。
|
|
|
|
**只有在你发布时,内容才会上线。** 你在编辑草稿时,它不会影响你的生产站点。何时部署其更改由你决定。
|
|
|
|
**可以同时保留多个草稿。** 并行处理多组更改,每组更改都在自己的草稿中,并可以分别发布。
|
|
|
|
<Note>
|
|
草稿与用于构建生产站点的部署分支相互独立。在你发布草稿之前,编辑草稿绝不会更改你的生产站点。
|
|
</Note>
|
|
|
|
<div id="create-a-draft">
|
|
## 创建草稿
|
|
</div>
|
|
|
|
1. 点击编辑器工具栏中的 <Icon icon="globe" /> 部署选择器。当你编辑部署分支时,它显示为 **Live site**。当你编辑草稿时,它显示该草稿的名称。
|
|
<Frame>
|
|
<img
|
|
className="block dark:hidden"
|
|
src="/images/editor/deployment-selector-light.png"
|
|
alt="编辑器工具栏中的部署选择器,显示生产站点。"
|
|
/>
|
|
<img
|
|
className="hidden dark:block"
|
|
src="/images/editor/deployment-selector-dark.png"
|
|
alt="编辑器工具栏中的部署选择器,在深色模式下显示生产站点。"
|
|
/>
|
|
</Frame>
|
|
2. 点击 **Drafts** 标签页。
|
|
3. 点击 <Icon icon="plus" /> **New draft**。
|
|
|
|
编辑器会创建草稿并切换到它。新草稿的初始名称为 "Untitled draft"。请为你的草稿起一个描述性的名字,方便你以后识别它们。
|
|
|
|
<div id="switch-between-drafts">
|
|
## 在草稿之间切换
|
|
</div>
|
|
|
|
1. 点击编辑器工具栏中的 <Icon icon="globe" /> 部署选择器。
|
|
2. 点击 **Live site** 返回你的部署分支,或点击另一个草稿以切换到它。
|
|
|
|
**Drafts** 标签页按最近更新时间倒序列出你的所有草稿。使用搜索框可按名称筛选草稿。
|
|
|
|
<div id="publish-a-draft">
|
|
## 发布草稿
|
|
</div>
|
|
|
|
当你的草稿准备就绪时,打开发布菜单以审阅你的更改并发布。可用的操作取决于你的部署分支是否要求在更改上线之前进行审阅。
|
|
|
|
<Steps>
|
|
<Step title="打开发布菜单">
|
|
点击编辑器工具栏中的 **Publish**。菜单会列出草稿中的每一处待发布更改。点击任意更改即可对其进行审阅。
|
|
</Step>
|
|
<Step title="请求审阅(如有需要)">
|
|
如果你的部署分支需要审阅,请点击 **Request review**,将该草稿的 pull request 标记为可供团队审阅。审阅者可以在编辑器中或在你的 Git 提供商处批准该 pull request。
|
|
</Step>
|
|
<Step title="发布">
|
|
点击 **Publish** 将草稿合并到部署分支并进行部署。如果你的团队要求审阅,只有在 pull request 获得批准后,**Publish** 才会变为可用状态。
|
|
|
|
每个草稿一次只能进行一次发布。如果已经有发布在进行中,请等待其完成后再重新发布。
|
|
</Step>
|
|
</Steps>
|
|
|
|
<div id="rename-a-draft">
|
|
## 重命名草稿
|
|
</div>
|
|
|
|
1. 点击编辑器工具栏中的 <Icon icon="globe" /> 部署选择器。
|
|
2. 点击 **Drafts** 标签页。
|
|
3. 将鼠标悬停在草稿上,然后点击 <Icon icon="pencil" /> 重命名图标。
|
|
4. 输入新名称并按 <kbd>Enter</kbd>。
|
|
|
|
重命名草稿也会同步更新其 pull request 的标题。
|
|
|
|
<div id="delete-a-draft">
|
|
## 删除草稿
|
|
</div>
|
|
|
|
1. 点击编辑器工具栏中的 <Icon icon="globe" /> 部署选择器。
|
|
2. 点击 **Drafts** 标签页。
|
|
3. 将鼠标悬停在草稿上,然后点击 <Icon icon="trash" /> 删除图标。
|
|
3. 确认删除。
|
|
|
|
<Warning>
|
|
删除草稿会永久丢弃其未发布的更改,并关闭其 pull request。此操作无法撤销。
|
|
</Warning>
|
|
|
|
<div id="drafts-versus-branches">
|
|
## 草稿与分支的对比
|
|
</div>
|
|
|
|
草稿和分支都能让你在发布前以隔离方式处理更改。根据你的团队工作方式进行选择:
|
|
|
|
- **使用草稿**:如果你希望由编辑器为你管理 Git。
|
|
- **使用分支**:如果你遵循基于 Git 的工作流,并希望自己命名分支、直接管理 pull request,或与在编辑器之外进行的更改保持一致。请参见 [分支和发布](/zh/editor/branching-and-publishing)。
|
|
|
|
这两种方式都可以在部署选择器中使用,你随时可以在两种方式之间切换。
|