在 Web 编辑器中协作

通过 branch、拉取请求、预览部署、可分享链接和实时编辑在网页编辑器中协作撰写文档。

使用基于 branch 的工作流、拉取请求和预览部署，与团队协作撰写文档。

如果你不熟悉 Git，请参阅 Web 编辑器的 Git 基础。

​

基于 branch 的协作

使用 branch 并行更新文档，在不影响线上站点的前提下完成修改。

​

为什么要使用 branch

• 隔离更改：在不影响线上文档的情况下进行更新。
• 发布前评审：在更改上线之前先获取团队成员的反馈。
• 并行协作：多个团队成员可以同时在不同的 branch 上工作。

​

推荐工作流

建议使用拉取请求（PR；亦称“合并请求”/Merge Request）在合并到线上文档之前提出更改并与团队协作。此工作流可以确保团队在发布前完成审查，并保持清晰的更新历史记录。

1. 创建拉取请求

   当你准备好发布更改时，可以在编辑器中创建拉取请求。有关使用拉取请求的更多信息，请参阅 在网页编辑器中发布更改。

2. 审查拉取请求

   在你的 Git 托管平台（如 GitHub 或 GitLab）中审查拉取请求。

3. 回应反馈

   当审查者请求更改时，根据要求进行修改并保存你的更改。后续的更改会自动推送到现有的拉取请求中。

4. 合并拉取请求

   当所有请求的更改都已处理、拉取请求已通过必需审查者批准且所有自动检查均已通过时，合并你的拉取请求。

​

预览部署

预览部署会创建临时 URL，你可以在更改正式上线之前先查看渲染效果。使用预览部署来收集关于你更改的反馈。

每次你在某个 branch 上保存更改时，预览部署都会自动更新。

​

访问预览部署

1. 在编辑器工具栏中点击 Publish。
2. 点击预览 URL，在新标签页中打开预览部署。URL 的格式为 organization-branch-name.mintlify.app。

​

分享预览

将预览部署的 URL 分享给团队成员以收集反馈。当你保存更多更改时，预览会自动更新。

​

预览认证

预览 URL 默认对所有人公开可访问。在控制台的 附加组件（Add-ons） 页面启用预览认证，以将访问限制为已通过认证的组织成员。

​

分享编辑器链接

将编辑器中某个特定页面的直接链接分享给你的团队成员。使用编辑器链接来协作更新内容并对页面进行修改。

当你打开一个页面时，编辑器会将路径记录在 URL 中。从浏览器地址栏中复制该 URL，与有编辑器访问权限的团队成员分享。

URL 的格式是：https://dashboard.mintlify.com/{org}/{project}/editor/{branch}/~/{filepath}

例如，https://dashboard.mintlify.com/acme/docs/editor/main/~/guides/quickstart.mdx 会在 main branch 上打开 quickstart.mdx 文件。

任何有权访问你所在 Mintlify 组织的人都可以使用该链接直接在编辑器中打开该文件。

当你分享页面链接时，告诉对方你当前使用的是哪个 branch，这样他们就能确认自己查看的是正确的版本。