编辑器概览
使用 Mintlify 编辑器在浏览器中创建、编辑和发布内容。支持实时协作和持续的 Git 同步。
创建分支、进行修改、共享预览并发布。
使用编辑器在浏览器中撰写和发布文档。编辑器采用 docs-as-code 工作流,你的所有更改都由 Git 保存。你的工作会以 commit 的形式保存到你的仓库中,编辑器会替你处理 Git 操作。
打开仪表板时会默认加载编辑器。组织中的任何成员都可以打开编辑器,但具体能执行哪些操作取决于你的角色。Admins 和 editors 可以编辑和发布。Viewers 可以浏览内容,并留下评论和建议。
更改会自动保存,但保存不等于发布。 在你输入时,编辑器会保存你的工作。你的更改会在标签页、设备和网络中断之间保留。若要让更改出现在你的线上站点上,你必须发布它们。
发布会写入 Git。 发布时,编辑器会把你的更改提交到你的仓库。如果你发布到 deployment branch,你的线上站点会立即更新。在 feature branch 上,你的编辑会自动提交到该分支,并打开一个 pull request 供人审阅。在合并到 deployment branch 之前,feature branch 上的任何内容都不会进入你的线上站点。
Git 保持同步。 当有人向你的仓库推送更改时,这些更改会自动出现。你无需 pull 或刷新页面。编辑器会合并没有冲突的更改,并标记出需要你处理的部分。
你的团队可以共同编辑。 多人可以同时编辑同一个页面,实时光标会显示每个人正在处理的位置。评论和建议对所有人可见。
如果编辑器看起来与你的仓库不同步,请使用重置编辑器强制重新同步。
- 顶部栏:通过 Ask agent 打开智能体。在 Site 标签页中,顶部栏还包含分支选择器、Preview 和 Publish。在 Workspace 标签页中,则显示 Share。点击 More options 可以执行页面操作,例如 Page settings、Comments、Version history、Duplicate 和 Move to。
- 侧边栏:使用侧边栏选择要编辑的页面、创建新页面并管理站点结构。按 Ctrl + \(macOS 和 Windows)可以隐藏或显示侧边栏。按 Cmd + K(macOS)或 Ctrl + K(Windows)可以搜索页面和仪表板。
- Workspace:不属于 Git 仓库或已发布站点的页面。Personal 中是你的私有草稿,Teamspace 中是与整个组织共享的页面,Shared with me 中是同事直接与你共享的页面。
- Site:你的仓库和已发布的站点。Navigation 包含站点导航中的页面。Files 列出仓库中不在导航里的文件。
可视化模式会在你输入时渲染页面。按 / 打开组件菜单并插入组件。
source 模式让你直接访问 MDX,并显示行号。适合精确控制组件属性和 frontmatter。输入 < 可访问组件。按 Cmd + S(macOS)或 Ctrl + S(Windows)可格式化文档。如果一次修改改变了超过 1,000 个字符,编辑器会请你确认。
两种模式编辑的是同一个文件,都支持实时协作。使用 Cmd + Shift + S(macOS)或 Ctrl + Shift + S(Windows)在两者之间切换,或使用 More options 中的 Source mode 开关。编辑器会在跨页面时记住你的选择。
有关可插入的组件,请参阅组件。有关 MDX 语法,请参阅文本格式和代码格式。
了解一些 Git 概念有助于你更好地使用编辑器。有关 commit、branch、pull request、merge、冲突和 diff 的定义,请参阅文档相关的 Git 概念。
| 编辑器中的操作 | 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 更新 | 传入的更改通过三方合并同步到编辑器中。 |