Skip to main content

第一次使用编辑器?请从教程开始。

创建分支、进行修改、共享预览并发布。
使用编辑器在浏览器中撰写和发布文档。编辑器采用 docs-as-code 工作流,你的所有更改都由 Git 保存。你的工作会以 commit 的形式保存在仓库中,编辑器会替你处理 Git 操作。 打开仪表板时会默认加载编辑器。组织中的任何成员都可以打开编辑器,但具体能执行哪些操作取决于你的角色。Admins 和 editors 可以编辑和发布。Viewers 可以浏览内容,并留下评论和建议

编辑器的工作方式

更改会自动保存,但保存不等于发布。 在你输入时,编辑器会保存你的工作。你的更改会在标签页、设备和网络中断之间保留。若要让更改出现在已发布的站点上,你必须发布它们。 发布会写入 Git。 发布时,编辑器会把你的更改提交到仓库。如果你发布到 deployment branch,已发布的站点会立即更新。在 feature branch 上,你可以把更改保存到该分支,或打开一个 pull request 供人审阅。在合并到 deployment branch 之前,feature branch 上的任何内容都不会进入已发布的站点。 Git 保持同步。 当有人向你的仓库推送更改时,这些更改会自动出现。你无需 pull 或刷新页面。编辑器会合并没有冲突的更改,并标记出需要你处理的部分。 你的团队可以共同编辑。 多人可以同时编辑同一个页面,实时光标会显示每个人正在处理的位置。评论和建议对所有人可见。
如果编辑器看起来与仓库不同步,请使用重置编辑器强制重新同步。

编辑器布局

  • 顶部栏:使用顶部栏选择你要工作的分支、使用智能体、预览和发布更改。
  • 侧边栏:使用侧边栏选择要编辑的页面、创建新页面并管理站点结构。
    • Home:项目的文件树。Personal 中的页面仅你自己可见。Workspace 中的页面对你的组织公开。
    • Publishing:站点的导航结构。按照你希望页面在站点上呈现的方式来组织它们。

可视化模式与 source 模式

可视化模式会在你输入时渲染页面。按 / 打开组件菜单并插入组件。 source 模式让你直接访问 MDX,适合精确控制组件属性和 frontmatter。 两种模式编辑的是同一个文件。使用 Cmd + Shift + S(macOS)或 Ctrl + Shift + S(Windows)在两者之间切换。 有关可插入的组件,请参阅组件。有关 MDX 语法,请参阅文本格式代码格式

Git 概念

了解一些 Git 概念有助于你更好地使用编辑器。有关 commit、branch、pull request、merge、冲突和 diff 的定义,请参阅文档相关的 Git 概念