启用 GitHub 同步

设置并授权 GitBook 的 GitHub 集成

开始使用

在您想要与 GitHub 仓库同步的空间中,前往 空间标题 在右上角,然后选择 配置。在提供者列表中,选择 GitHub 同步.

A GitBook screenshot showing GitHub Sync configuration options
GitHub 同步配置选项。

使用 GitHub 进行身份验证

如果您是首次设置 GitHub 同步且尚未关联 GitHub 帐户,开始配置 Git 同步时系统会提示您进行关联。如果您已经关联了帐户,可能仍需通过 GitHub 进行身份验证。

将 GitBook 应用安装到您的 GitHub 帐户

如果您尚未这样做,您会看到提示,要求添加 GitBook 应用 到您的 GitHub 帐户。

按照 GitHub 弹出窗口中的说明,依据需要为 GitBook 授予特定仓库权限,或允许访问所有仓库。

选择仓库和分支

选择您希望与 GitBook 内容保持同步的帐户和仓库。

看不到您的仓库? 如果在列表中找不到您的仓库,请确保您已在正确的作用域中安装了 GitBook GitHub 应用 (例如,您的个人帐户或存放该仓库的 GitHub 组织)。您还应检查是否在 GitBook GitHub 应用中配置了正确的仓库访问权限。

选择正确的仓库后,选择要将提交推送到并从中同步的分支。

执行初始同步

首次同步时,您可以选择以下两个方向之一进行同步:

  1. 从 Git到 Book -> GitHub 将同步您空间的内容 所选分支。如果您从一个空仓库开始并希望快速将 GitBook 内容导入,这是很好的选择。

  2. 从 GitHub -> Git到 Book 将同步您空间的内容 所选分支。如果您的仓库中已有现有的 Markdown 内容并希望将其导入到 GitBook,这将非常有用。

编写并提交

您可以开始使用了。您会注意到如果您的空间处于 实时编辑 模式,实时编辑现在已被锁定。这使我们能够在团队中的某人在 GitBook 中合并 变更请求 时可靠地将内容同步到您的仓库。

当您在 GitBook 上编辑时,每次变更请求合并都会导致向您所选的 GitHub 分支提交一次提交。

当您向 GitHub 提交时,每次提交都会作为历史提交同步到您的 GitBook 空间。

最后更新于

这有帮助吗?