跳转到主要内容
预览部署适用于 Pro 和 Custom 方案。
预览部署可让你在合并到生产环境之前先查看文档更改的实际效果。每次预览都会生成一个可共享的 URL，并会在你推送新更改时自动更新。 预览 URL 默认对所有人可见。将预览链接分享给任何需要审阅你更改的人。

​
创建预览部署

预览部署会在拉取请求（PR；亦称“合并请求”/Merge Request）中自动创建，或可从你的控制台手动创建。

​
自动预览

仅针对目标为你的部署用分支的拉取请求（PR），才会自动创建预览。
当你创建拉取请求时，Mintlify 机器人会自动在拉取请求中添加一个链接，供你查看预览部署。每次你向该分支推送新的提交时，预览都会更新。
在拉取请求时间线中查看部署的链接

​
手动预览

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

​
重新部署预览

当需要刷新内容，或在部署失败后重试时，可重新部署预览。
  1. 在你的控制台中选择该预览。
  2. 选择重新部署。
“预览”菜单中，部署按钮被橙色矩形高亮显示。

​
限制预览部署的访问权限

默认情况下，任何持有 URL 的人都可以公开访问预览部署。你可以将访问权限限制为 Mintlify 组织中的已认证成员。
  1. 在控制台的 附加组件 页面，进入 Previews 部分。
  2. 点击 Preview authentication 开关以启用或禁用预览认证。
附加组件页面中的预览认证开关

​
预览部署故障排查

如果预览部署失败，请尝试以下排查步骤。
  • 查看构建日志：在你的仪表盘中，进入 Previews 并点击失败的预览。部署日志会显示导致失败的错误。
  • 检查配置：
    • docs.json 语法无效
    • 导航中引用的文件路径缺失或不正确
    • MDX 文件中的 frontmatter 无效
    • 图片链接损坏或图片文件缺失
  • 本地验证：在本地运行 mint dev，在推送到代码仓库之前先发现构建错误。
  • 检查最近变更：查看分支中最近的提交，找出导致构建失败的变更。