跳转到主要内容
编辑时你的更改会自动保存,但只有在你发布之后才会出现在你的线上站点上。发布时会发生什么,取决于你在哪个分支上工作,以及该分支是否设置了分支保护。
Publish 只在打开站点页面时显示。私有页面会显示 Share,并且永远不会发布。Viewers 看不到 Publish。如果站点页面上没有 Publish 按钮,说明你的项目启用了自动发布,你的编辑会自动上线。如果没有分支选择器,请显示分支选择器。如果 Publish 菜单中只看到你自己的更改,请开启 Show teammates’ changes 以查看所有人的更改。如果在 deployment branch 上显示的是 Request review 而不是 Publish,说明你的项目要求发布前审阅。

待处理更改

在你的 deployment branch 上,编辑器会把以下内容记录为待处理更改,直到你发布它们:
  • 页面中的内容编辑
  • 新增或删除的页面
  • 导航结构的更改
  • 上传的媒体文件
  • 配置更新
点击工具栏中的 Publish 即可查看待处理更改。点击任意已更改的文件即可将其与已发布版本进行比较。

发布时会发生什么

  • Publish:将你的待处理更改提交到 deployment branch 并部署到你的线上站点。
  • Request review:在 feature branch 上,为该分支打开 pull request,或将其草稿 pull request 标记为可供审阅。在要求审阅的 deployment branch 上,请同事在编辑器中批准你的更改。
  • Merge and publish:将 pull request 合并到 deployment branch 并进行部署。当 pull request 达到可供审阅或已获批准状态(取决于你仓库的审阅要求)后即可使用。如果你的项目要求发布前审阅,只有 admins 可以从编辑器合并到 deployment branch。
  • Create branch:当你无法发布到当前分支时,创建一个新的 feature branch。
每个分支同一时间只能进行一次发布。如果同事已在向同一分支发布,你的发布会进入队列等待,并在其发布完成后自动开始。
Mintlify 完成构建和部署后,你的线上站点才会更新。这通常需要 30 秒到几分钟。Publish 菜单会显示你的更改在提交、构建和部署过程中的进度,然后链接到线上页面。如果构建失败,请点击 View build log。

无效的 MDX 会阻止发布

如果你分支上的任何页面存在无效的 MDX,编辑器会禁用 Publish 和 Request review 按钮,直到你修复它。将鼠标悬停在 Publish 上可查看有多少页面存在错误,然后以 source 模式打开每个页面查看并修复错误。有关详细信息,请参阅由于 MDX 无效导致发布按钮被禁用。

发布特定更改

当多人在你的 deployment branch 上有待处理更改时,Show teammates’ changes 设置控制 Publish 菜单列出哪些更改。 Show teammates’ changes 关闭(默认):Publish 菜单仅在 Your changes 下列出你的更改。这包括你编辑过的文件、你和同事都编辑过的文件,以及没有记录作者的文件。同事的其他待处理更改不会出现在菜单中。 你的每项更改都带有复选框,并且默认全部选中。取消勾选你想排除的更改,然后点击 Publish。只有选中的更改会被发布。如果你取消勾选所有复选框,编辑器会禁用 Publish。 Show teammates’ changes 开启:Publish 菜单会把待处理更改分为 Your changes 和 Modified by others。你的更改默认选中,其他人的更改默认未选中。使用复选框选择要发布的更改。 每个分区都有各自的 Discard 按钮,只对该分区中的更改生效。 对于由你之外的成员编辑过的文件,会显示一个贡献者图标。将鼠标悬停在上面即可查看是谁编辑了该文件。
  • 选择要发布的更改仅在没有分支保护的 deployment branch 上生效。在 feature branch 上,发布会包含所有待处理更改。
  • 如果你的 deployment branch 要求审阅,且你的角色无法在未审阅的情况下发布,Publish 菜单只显示你自己的更改。
  • 删除文件夹会删除其中所有页面。这些删除操作会一起发布。你无法只删除文件夹中的一部分。
  • 有些更改互相依赖,例如页面及其导航条目。如果你的选择忽略了某个被选更改所依赖的更改,发布会失败并显示错误。请调整你的选择以包含该依赖,然后再次发布。

在分支上工作

如果你不使用审阅工作流,可以直接在 deployment branch 上编辑。如果每项更改在上线前都需要审阅,请创建分支。 若要创建分支:
  1. 点击编辑器工具栏中的分支名称。在 deployment branch 上,该名称会带有 Live 徽章。
  2. 可选:在 Find a branch 中为分支输入标题。
  3. 点击 New branch。
如果你不输入标题,编辑器会以当前日期为分支命名。如果创建分支时你有待处理更改,编辑器会询问是 Bring them to this branch 还是 Leave them behind。无论哪种选择,你的原始分支都会保留其待处理更改。 在编辑器中创建的分支或带有打开 pull request 的分支上进行的编辑会自动提交到该分支,通常在你停止编辑约 15 秒后。首次提交会打开一个针对 deployment branch 的 pull request。如果启用了默认创建草稿 pull request,pull request 会以草稿形式打开。 准备好之后,点击 Publish,然后点击 Request review。当你的 pull request 满足仓库的审阅要求后,点击 Merge and publish。编辑器会合并 pull request,并把你切换回 deployment branch。

管理分支

分支菜单会列出你的 deployment branch、你在编辑器中创建的分支,以及带有打开或草稿 pull request 的分支,包括在编辑器之外打开的 pull request。每个分支都会显示其 pull request 状态。若要查找已合并或已关闭的分支,或仓库中的任何其他分支,请按名称搜索。若要无需搜索即可列出所有分支,请在编辑器设置中开启显示所有分支。 若要重命名或删除分支,请在分支菜单中将鼠标悬停在其上并点击 Rename branch 或 Delete branch,然后确认。重命名会更改编辑器中显示的标题和 pull request 标题,Git 分支名称保持不变。删除分支会关闭其 pull request,并将该分支永久从你的仓库中移除,同时删除其上任何未发布的更改。Viewers 无法重命名或删除分支。

子分支

如果你的仓库位于 GitHub、GitLab 或 Azure Repos 上,你可以在子分支上工作:子分支的父分支是 deployment branch 以外的分支,例如用于大型更新的功能分支。当你在另一个非 deployment branch 上时在编辑器中创建分支,或者分支的 pull request 以非 deployment branch 为目标时,该分支就会成为子分支。分支菜单会列出带有打开或草稿 pull request 的子分支,包括在编辑器之外打开的 pull request。 你在编辑器中创建的子分支,其 pull request 默认以 deployment branch 为目标。 当子分支的 pull request 处于打开状态时,发布菜单会显示两个按钮,取代 Publish 或 Merge and publish:
  • Publish to <deployment branch>:将子分支合并到 deployment branch 并进行部署。
  • Merge into <parent branch>:将子分支合并到其父分支。在父分支合并到 deployment branch 之前,你的线上站点不会改变。
如果你点击的按钮对应的分支尚不是 pull request 的目标分支,编辑器会先在你的 Git 提供商中更改 pull request 的目标分支,然后再合并。如果无法更改目标分支,编辑器会显示错误且不会合并。合并后,编辑器会将你切换到合并目标分支。 发布菜单中的分支更改列表会将你的子分支与其 pull request 当前的目标分支进行比较。

显示分支选择器

如果你的 deployment branch 没有分支保护,当你在 deployment branch 上工作时,编辑器会隐藏分支选择器。若要显示它,请打开一个站点页面,点击顶部栏中的 More options,然后开启 Branches。此偏好设置仅对你生效。 当你的 deployment branch 具有分支保护,或你在 feature branch 上工作时,分支选择器始终显示。

解决冲突

当有人从编辑器之外向你的仓库推送时,编辑器会把他们的更改合并到你打开的页面中。通知会告诉你应用了多少次更新。 如果远程更改和你的编辑影响了页面的同一部分,编辑器会同时保留两个版本并高亮显示。查看高亮内容,保留你想要的版本,删除另一个版本。

提交签名

在你的个人资料设置的 Integrations 部分授权 GitHub 账户,即可用它签署 commit。未经授权时,编辑器中所做的 commit 由 Mintlify GitHub App 签署。

自动发布

如果你的项目启用了自动发布,在你停止编辑大约一分钟后,编辑器就会提交到你的 deployment branch。分支选择器和 Publish 按钮会被隐藏。没有待处理状态,也没有审阅环节。 自动发布和 Require review before publishing 不能同时开启。如果 admin 开启其中一个,另一个会自动关闭。