预览部署适用于 Pro 和 Enterprise 方案
通过预览部署,你可以在合并到生产环境前先查看文档更改的实际呈现效果。每次预览都会生成一个可分享的 URL,并会在你推送新更改时自动更新。

创建预览部署

预览部署会在发起 pull request 时自动创建,也可在你的仪表盘中手动创建。

自动预览

当你创建 pull request 时,Mintlify 机器人会在该 pull request 中自动添加一个链接,用于查看预览部署。每次你向该分支推送新的提交,预览都会随之更新。
在 pull request 时间线中查看部署的链接

手动预览

你可以为任意分支手动创建预览。
  1. 前往你的控制台
  2. 选择 Previews
  3. 选择 Create preview
  4. 输入分支名称。
  5. 选择 Create deployment

重新部署预览

当需要刷新内容或在部署失败后重试时,可以重新部署预览。
  1. 在你的仪表盘中选择该预览。
  2. 点击Redeploy
“预览”菜单,部署按钮以橙色矩形突出显示。

共享预览部署

预览部署可以设置为公开访问,或仅限已通过身份验证的用户访问。 公开访问:预览 URL 默认对所有人可见。将预览链接分享给需要审阅你更改的人。 受限访问:启用预览部署的身份验证,将预览访问限制为仅限已通过身份验证的 Mintlify 用户。详见身份验证设置