# 编辑器概览 (/zh/editor)

<!-- agent-signals: reading_time_min: 3 · est_tokens: 1727 · updated: 2026-09-23 -->

<Card title="第一次使用编辑器？请从教程开始。" icon="<svg xmlns=&#x22;http://www.w3.org/2000/svg&#x22; viewBox=&#x22;0 0 24 24&#x22; fill=&#x22;none&#x22;><path d=&#x22;M22 9V15&#x22; stroke=&#x22;currentColor&#x22; stroke-linecap=&#x22;round&#x22; stroke-linejoin=&#x22;round&#x22; stroke-width=&#x22;1.5&#x22;/><path d=&#x22;M18 12V15.0669C18 16.1333 18 16.6665 17.737 17.1071L17.7316 17.1159C17.4661 17.5551 16.9843 17.8238 16.0206 18.3611C14.0645 19.4518 13.0864 19.9972 12.0109 20H11.9891C10.9136 19.9972 9.93551 19.4518 7.97941 18.3611C7.01574 17.8238 6.53391 17.5551 6.2684 17.1159L6.26305 17.1071C6 16.6665 6 16.1333 6 15.0669V12&#x22; stroke=&#x22;currentColor&#x22; stroke-linecap=&#x22;round&#x22; stroke-linejoin=&#x22;round&#x22; stroke-width=&#x22;1.5&#x22;/><path d=&#x22;M8.52143 5.22252L4.40645 7.2074C2.80215 7.98124 2 8.36816 2 8.99125C2 9.61434 2.80215 10.0013 4.40645 10.7751L8.598 12.7969C10.2608 13.599 11.0922 14 11.9816 14C12.8711 14 13.7025 13.599 15.3653 12.7969L19.6386 10.7356C21.2141 9.97571 22.0018 9.59575 22 8.97064C21.9982 8.34553 21.2146 7.97321 19.6473 7.22857C18.2179 6.5494 16.8685 5.92516 15.433 5.24184C13.6907 4.41243 12.8195 3.99772 11.9353 4.00001C11.0512 4.00229 10.2079 4.40904 8.52143 5.22252Z&#x22; stroke=&#x22;currentColor&#x22; stroke-linecap=&#x22;round&#x22; stroke-linejoin=&#x22;round&#x22; stroke-width=&#x22;1.5&#x22;/></svg>" href="/zh/editor/tutorial">
  创建分支、进行修改、共享预览并发布。
</Card>

使用编辑器在浏览器中撰写和发布文档。编辑器采用 docs-as-code 工作流，你的所有更改都由 Git 保存。你的工作会以 commit 的形式保存到你的仓库中，编辑器会替你处理 Git 操作。

打开[仪表板](https://app.mintlify.com)时会默认加载编辑器。组织中的任何成员都可以打开编辑器，但具体能执行哪些操作取决于你的[角色](/zh/dashboard/roles)。Admins 和 editors 可以编辑和发布。Viewers 可以浏览内容，并留下[评论和建议](/zh/editor/collaborate)。

<div id="how-the-editor-works">
  ## 编辑器的工作方式 [#编辑器的工作方式]
</div>

**更改会自动保存，但保存不等于发布。** 在你输入时，编辑器会保存你的工作。你的更改会在标签页、设备和网络中断之间保留。若要让更改出现在你的线上站点上，你必须[发布](/zh/editor/publish)它们。

**发布会写入 Git。** 发布时，编辑器会把你的更改提交到你的仓库。如果你发布到 deployment branch，你的线上站点会立即更新。在 feature branch 上，你的编辑会自动提交到该分支，并打开一个 pull request 供人审阅。在合并到 deployment branch 之前，feature branch 上的任何内容都不会进入你的线上站点。

**Git 保持同步。** 当有人向你的仓库推送更改时，这些更改会自动出现。你无需 pull 或刷新页面。编辑器会合并没有冲突的更改，并标记出需要你处理的部分。

**你的团队可以共同编辑。** 多人可以同时编辑同一个页面，实时光标会显示每个人正在处理的位置。评论和建议对所有人可见。

<Tip>
  如果编辑器看起来与你的仓库不同步，请使用[重置编辑器](/zh/editor/settings#reset-editor)强制重新同步。
</Tip>

<div id="editor-layout">
  ## 编辑器布局 [#编辑器布局]
</div>

<Frame>
  <img src="/_assets/941c0fc71fcdefe2624848a0026d70aaae6bf64574fc1080df3f10372cceccfb" alt="编辑器的屏幕截图，其中选中了 Site 标签页。" className="dark:hidden" />

  <img src="/_assets/f3bbe6e3f0fc4e59421abe42f1ab3bbe7a5b2556576a57902b54755949388f6d" alt="编辑器的屏幕截图，其中选中了 Site 标签页。" className="hidden dark:block" />
</Frame>

* **顶部栏**：通过 **Ask agent** 打开智能体。在 **Site** 标签页中，顶部栏还包含分支选择器、**Preview** 和 **Publish**。在 **Workspace** 标签页中，则显示 **Share**。点击 <Icon icon="<svg xmlns=&#x22;http://www.w3.org/2000/svg&#x22; viewBox=&#x22;0 0 24 24&#x22; fill=&#x22;none&#x22;><path d=&#x22;M12 12.002H12.5M19 12.002H19.5M5 12.002H5.5M12 13.002C12.5523 13.002 13 12.5542 13 12.002C13 11.4497 12.5523 11.002 12 11.002C11.4477 11.002 11 11.4497 11 12.002C11 12.5542 11.4477 13.002 12 13.002ZM19 13.002C19.5523 13.002 20 12.5542 20 12.002C20 11.4497 19.5523 11.002 19 11.002C18.4477 11.002 18 11.4497 18 12.002C18 12.5542 18.4477 13.002 19 13.002ZM5 13.002C5.55228 13.002 6 12.5542 6 12.002C6 11.4497 5.55228 11.002 5 11.002C4.44772 11.002 4 11.4497 4 12.002C4 12.5542 4.44772 13.002 5 13.002Z&#x22; stroke=&#x22;currentColor&#x22; stroke-linecap=&#x22;round&#x22; stroke-linejoin=&#x22;round&#x22; stroke-width=&#x22;1.5&#x22;/></svg>" /> **More options** 可以执行页面操作，例如 **Page settings**、**Comments**、**Version history**、**Duplicate** 和 **Move to**。
* **侧边栏**：使用侧边栏选择要编辑的页面、创建新页面并管理站点结构。按 <kbd>Ctrl</kbd> + <kbd>\\</kbd>（macOS 和 Windows）可以隐藏或显示侧边栏。按 <kbd>Cmd</kbd> + <kbd>K</kbd>（macOS）或 <kbd>Ctrl</kbd> + <kbd>K</kbd>（Windows）可以搜索页面和仪表板。
  * **Workspace**：不属于 Git 仓库或已发布站点的页面。**Personal** 中是你的私有草稿，**Teamspace** 中是与整个组织共享的页面，**Shared with me** 中是同事直接与你共享的页面。
  * **Site**：你的仓库和已发布的站点。**Navigation** 包含站点导航中的页面。**Files** 列出仓库中不在导航里的文件。

<div id="visual-and-source-mode">
  ## 可视化模式与 source 模式 [#可视化模式与-source-模式]
</div>

**可视化模式**会在你输入时渲染页面。按 <kbd>/</kbd> 打开组件菜单并插入组件。

**source 模式**让你直接访问 MDX，并显示行号。适合精确控制组件属性和 frontmatter。输入 <kbd>\<</kbd> 可访问组件。按 <kbd>Cmd</kbd> + <kbd>S</kbd>（macOS）或 <kbd>Ctrl</kbd> + <kbd>S</kbd>（Windows）可格式化文档。如果一次修改改变了超过 1,000 个字符，编辑器会请你确认。

两种模式编辑的是同一个文件，都支持[实时协作](/zh/editor/collaborate#real-time-editing)。使用 <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>S</kbd>（macOS）或 <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>S</kbd>（Windows）在两者之间切换，或使用 <Icon icon="<svg xmlns=&#x22;http://www.w3.org/2000/svg&#x22; viewBox=&#x22;0 0 24 24&#x22; fill=&#x22;none&#x22;><path d=&#x22;M12 12.002H12.5M19 12.002H19.5M5 12.002H5.5M12 13.002C12.5523 13.002 13 12.5542 13 12.002C13 11.4497 12.5523 11.002 12 11.002C11.4477 11.002 11 11.4497 11 12.002C11 12.5542 11.4477 13.002 12 13.002ZM19 13.002C19.5523 13.002 20 12.5542 20 12.002C20 11.4497 19.5523 11.002 19 11.002C18.4477 11.002 18 11.4497 18 12.002C18 12.5542 18.4477 13.002 19 13.002ZM5 13.002C5.55228 13.002 6 12.5542 6 12.002C6 11.4497 5.55228 11.002 5 11.002C4.44772 11.002 4 11.4497 4 12.002C4 12.5542 4.44772 13.002 5 13.002Z&#x22; stroke=&#x22;currentColor&#x22; stroke-linecap=&#x22;round&#x22; stroke-linejoin=&#x22;round&#x22; stroke-width=&#x22;1.5&#x22;/></svg>" /> **More options** 中的 **Source mode** 开关。编辑器会在跨页面时记住你的选择。

有关可插入的组件，请参阅[组件](/zh/components)。有关 MDX 语法，请参阅[文本格式](/zh/create/text)和[代码格式](/zh/create/code)。

<div id="git-concepts">
  ## Git 概念 [#git-概念]
</div>

了解一些 Git 概念有助于你更好地使用编辑器。有关 commit、branch、pull request、merge、冲突和 diff 的定义，请参阅[文档相关的 Git 概念](/zh/guides/git-concepts)。

| 编辑器中的操作                 | Git 操作                                                                                      |
| ----------------------- | ------------------------------------------------------------------------------------------- |
| 编辑页面                    | 自动保存。尚未创建 commit。                                                                           |
| 在 deployment branch 上发布 | `git commit` 和 `git push`。触发部署。                                                             |
| 在 feature branch 上编辑    | 在你停止编辑约 15 秒后，`git commit` 并 `git push` 到该分支。首次提交时会打开一个针对 deployment branch 的 pull request。 |
| Request review          | 将 pull request 标记为可供审阅。                                                                     |
| Merge and publish       | 合并 pull request 并触发部署。                                                                      |
| 创建分支                    | `git checkout -b <branch-name>`                                                             |
| 切换分支                    | `git checkout <branch-name>`                                                                |
| 外部 push 或 CLI 更新        | 传入的更改通过三方合并同步到编辑器中。                                                                         |