Skip to main content
编辑时你的更改会自动保存,但只有在你发布之后才会出现在已发布的站点上。发布时会发生什么,取决于你在哪个分支上工作,以及该分支是否要求使用 pull request。
如果你看不到分支选择器或 Publish 按钮,说明你的 deployment 已启用自动发布,你的更改会自动上线。

待处理更改

编辑器会把以下内容记录为待处理更改:
  • 页面中的内容编辑
  • 新增或删除的页面
  • 导航结构的更改
  • 上传的媒体文件
  • 配置更新
如果没有待处理更改,编辑器会禁用发布和保存操作。

发布时会发生什么

  • Publish:立即提交并把更改部署到已发布的站点。
  • Save in branch:把更改提交到 feature branch,但不合并到 deployment branch。
  • Create branch:当你位于受保护的 deployment branch 上时,把待处理更改移动到新的 feature branch。
  • Create pull request:打开一个以 deployment branch 为目标的 pull request。
每个分支同一时间只能进行一次发布。如果同事正在向同一分支发布,请等待其发布完成后再重试。
Mintlify 完成构建和部署后,你的站点才会更新。这通常需要 30 秒到几分钟。请在仪表板上查看部署状态。

何时使用分支

如果你不使用基于 Git 的工作流,可以直接在 deployment branch 上编辑。如果每项更改在上线前都需要审阅,请创建分支。 若要创建分支,请点击编辑器工具栏中的分支名称,选择 Create new branch,输入名称,然后点击 Create branch
在有未发布更改时创建或切换分支,系统会询问你是把这些更改一起带走,还是留在原处。留下的更改会保留在原分支上。

解决冲突

当你的分支与 deployment branch 对相同文件做了不兼容的更改时,就会产生冲突。例如,你和同事编辑了相同的行,或者把同一个文件移动到了不同位置。 当有人从编辑器之外向仓库推送更改时,编辑器会自动应用不重叠的更改。如果远程更改与你的编辑影响页面的同一部分,编辑器会高亮显示该冲突。 当冲突导致无法发布时,编辑器会显示警告。请按照提示选择每处冲突要保留的版本。

提交签名

账户设置中授权你的 GitHub 账户,即可用它签署 commit。未授权时,编辑器中的 commit 由 Mintlify GitHub App 签署。

自动发布

如果你的 deployment 启用了自动发布,在你停止输入后不久,编辑器就会提交到 deployment branch。分支选择器和 Publish 按钮会被隐藏,没有待处理状态,也没有审阅环节。 无论是否启用该设置,在编辑器中创建的 feature branch 上的编辑都会自动提交,但除非你把它们合并到 deployment branch,否则永远不会发布。