跳转到主要内容

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

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

​
编辑器的工作方式

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

​
编辑器布局

  • 顶部栏：点击 Collapse sidebar 可隐藏页面列表，点击 Ask agent 可在页面旁打开智能体。在站点页面上，顶部栏还包含 Preview 和 Publish，以及可见时的分支选择器。在私有页面上，则显示 Share。点击 More options 可以执行页面操作，例如 Page settings、Comments、Version history、Duplicate 和 Move within project。
  • 侧边栏：使用侧边栏选择要编辑的页面、创建新页面、管理站点结构，以及在仪表板中切换位置。按 Cmd + \（macOS）或 Ctrl + \（Windows）可以隐藏或显示页面列表。按 Cmd + K（macOS）或 Ctrl + K（Windows）可以搜索仪表板。
    • 仪表板图标：通过顶部的菜单切换项目。点击 Home 可从仪表板任意位置返回编辑器，点击 Search 可搜索页面、设置和自动化。其下方可打开 Publishes、Analytics、Automations、MCP 和 Settings。在底部，点击 Get help 可查看文档、获取支持和了解产品更新，点击你的头像可打开个人资料菜单。
    • 页面：Navigation 包含站点导航中的页面。Files 列出仓库中不在导航里的文件。如果你使用私有页面，Personal 中是你的私有草稿，Shared with me 中是同事直接与你共享的页面。

​
搜索仪表板

按 Cmd + K（macOS）或 Ctrl + K（Windows），或点击侧边栏中的 Search，即可搜索仪表板。在可视化模式下，请先取消选中所有文本，因为 Cmd + K 会为所选文本添加链接。 搜索可以找到：
  • 你的页面。
  • 设置页面。
  • docs.json 中的各个部分，会在编辑器中打开。
  • Analytics 和 Publishes 中的各个部分。
  • 按名称查找的自动化。
搜索还可以执行操作，例如邀请成员、创建自动化、打开或关闭智能体、显示或隐藏侧边栏、在浅色和深色主题之间切换、联系支持，以及打开键盘快捷键列表。部分操作（例如邀请成员）仅在你的角色允许时才会显示。 在你输入之前，搜索会针对你当前所在的页面推荐结果。例如，在设置页面上，它会推荐该页面的各个部分；在编辑器中，它会推荐站点配置的各个部分。

​
可视化模式与 source 模式

可视化模式会在你输入时渲染页面。按 / 打开组件菜单并插入组件。 source 模式让你直接访问 MDX，并显示行号。适合精确控制组件属性和 frontmatter。输入 < 可访问组件。按 Cmd + S（macOS）或 Ctrl + S（Windows）可格式化文档。如果一次修改改变了超过 10,000 个字符，编辑器会请你确认。 两种模式编辑的是同一个文件，都支持实时协作。使用 Cmd + Shift + S（macOS）或 Ctrl + Shift + S（Windows）在两者之间切换，或使用 More options 中的 Source mode 开关。编辑器会在跨页面时记住你的选择。开启建议模式时，source 模式不可用。 有关可插入的组件，请参阅组件。有关 MDX 语法，请参阅文本格式和代码格式。

​
Git 概念

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