GitHub 拉取请求预览

在 GitHub 中发起拉取请求时预览你的内容

当您向已同步到 GitBook 空间的 GitHub 分支提交拉取请求（PR）时，您可以在合并之前预览内容。这使您能够在合并更改之前检查其影响。

您可以使用此功能在合并 PR 之前进行最后一层检查，让您在将其合并到已同步分支之前，先在非生产环境中查看更改。

如何访问预览链接

此行为开箱即用，前提是您已授予 GitBook GitHub 应用 对 PR 所需的只读权限。

对于使用与 GitBook 空间同步的目标分支创建的每个 PR，您都会看到该 PR 上添加了一个带有唯一预览 URL 的状态。点击 详情 状态上的链接将带您前往该内容的预览 URL。然后，您可以在合并 PR 之前确保内容符合预期。

预览链接仅对拥有 GitBook 账户的用户可访问。

安全注意事项

出于安全原因，默认情况下，GitBook 目前不会为从您仓库的 fork 打开的 PR 生成预览。因为 PR 预览中的内容可在您的自定义域名下访问，无论是在 .gitbook.io 还是您的自定义域名下，用户都可能在您公共仓库的 fork 中生成恶意内容，并使其以您的名义展示。

我们允许用户通过 Git Sync 设置中的一个选项显式配置此行为。

常见问题

为什么我在拉取请求中看不到我的 GitBook 文档预览？

常见原因：

• 您的站点尚未发布。 PR 预览 URL 是从您已发布的文档站点提供的（在 .gitbook.io 或您的自定义域名上）。

• 您的站点位于需要身份验证的访问之后。 Git Sync PR 预览不适用于发布在以下位置之后的站点 已认证访问.