启用 GitHub 同步

将你的 GitHub 仓库与 GitBook 同步

本指南将带你完成将带有 GitHub 仓库的 GitBook 站点设置过程。

GitHub 同步配置选项。

1

为你的站点打开 Git 同步

在你的站点中，从侧边栏打开 Git 同步。

2

连接 GitHub

连接拥有你想要同步的仓库访问权限的 GitHub 账户。

如果你在此步骤看到 “可能存在重复账户” 错误消息，这意味着你的 GitHub 账户已经与另一个 GitBook 用户账户关联。

为了帮助你识别哪些账户已关联，你需要退出当前会话，并使用 GitHub 登录方式重新登录。

如果你已经知道与你的 GitHub 关联的 GitBook 账户，你可以登录到该用户账户，并先取消关联你的 GitHub 账户（在设置中完成），然后再重新登录并关联你当前的账户。

阅读我们的 故障排除页面.

3

选择仓库和分支

在 源仓库，选择包含你文档的仓库。选择 GitBook 要同步的分支。如果该分支不存在，GitBook 会在初始同步期间创建它。

找不到你的仓库？ 如果你在列表中找不到你的仓库，请确保你已安装 GitBook GitHub 应用 ，并且安装在正确的范围内（即你的个人账户或仓库所在的 GitHub 组织）。你还应该检查是否在 GitBook GitHub 应用中配置了正确的仓库访问权限。

4

选择初始同步方向

为初始同步选择事实来源。选择 切换方向 ，如果仓库内容应替换 GitBook 内容。

GitHub → GitBook 可以替换你章节的内容。 如果你选择一个空仓库，GitBook 可以用仓库中的空内容替换你的章节。

在开始初始同步之前，请确认仓库、分支和方向。确保目标内容可以安全替换。

5

设置项目目录

如果你的文档位于子目录中，请在 项目目录下输入它。GitBook 会将你站点的 docs.yaml 文件存储在此目录中。如果你的文档位于一个 monorepo.

6

映射你的空间

在 内容映射，将每个空间分配到仓库中的一个目录。对于相对于项目目录的路径，请使用 ./ 。对于来自仓库根目录的路径，请使用 / 。新关联的空间会自动同步。

7

查看高级选项

如有需要，可配置代理指令文件、提交消息模板或 fork 预览。

8

同步你的站点

点击 同步 以开始初始同步。

9

写入并提交

在 GitBook 中合并变更请求，以将其更改提交到 GitHub。提交到 GitHub 的更改会同步回 GitBook。

从站点级 Git 同步中排除一个空间

在该站点的 Git 同步内容映射中，点击你要排除的空间旁边的移除图标。然后你就可以从该空间配置 Git 同步。

如果该站点已经使用 Git 同步，GitBook 会让你选择一个范围：

• 选择该站点的仓库和分支，将该空间添加到站点级 Git 同步中。
• 选择一个独立的仓库和分支来配置空间 Git 同步。

如果该站点不使用 Git 同步，GitBook 会为该空间独立配置 Git 同步。

要为单个空间配置 Git 同步，在你要同步的空间中，点击 设置 旁边的 Git Sync 中启用 空间标题。在提供方列表中，点击 GitHub 同步.

为我们的 GitHub 集成提供支持的 GitHub 应用当前不适用于 GitHub Enterprise Server 实例上的客户。