GitBook 集成GitHub

GitBook 完美的集成了 GitHub 来托管你书本的源代码。

连接你的账号/权限

在集成你的书本和 GitHub 前，你需要授予 GitBook 访问你的 GitHub 账号的权限。

在你的 账号设置 里，使用正确的权限连接你的 GitHub 账号：

• 默认的权限：仅仅在登陆的时候访问你的 GitHub 账号来验证你
• 访问 webhook：访问你的 GitHub 账号来在指定的仓库中创建 webhook（查看webhooks）
• 访问公开的仓库：从网页编辑器中访问你的 GitHub 仓库，你可以很容易的在 GitBook 中编辑你的书本（仅仅公共仓库）
• 访问私有的仓库：和上面一项目一样，但是只能访问私有仓库

从 GitHub 导入书

创建一本新书的时候，GitHub 标签页让你选择一个 GitHub 仓库导入。

新创建的书会使用你仓库的内容，webhook 也会自动添加。

Webhooks

当你的 GitHub 的仓库改变时，Webhooks 会通知 GitBook。

如果你的 GitHub 仓库改变时，GitBook 没有收到通知，这个问题的主要原因是 webhook。你可以检查仓库设置中 webhook 的状态。

连接书本和 GitHub 仓库

当你的 GitHub 账号正确地连接到你的 GitBook 账号后，将一本书链接至一个仓库很简单。

警告：当你在你书本的设置中指定了一个 GitHub 仓库，这个仓库会优先于 GitBook 的 git 仓库，这意味着编辑器会直接编辑 GitHub 中的内容。

1. 打开你书本设置中的 GitHub 部分
2. 输入你的仓库 id（例如：YourGitHubUserName/RepoName）
3. 保存你的设置
4. 点击 Add a deployment webhook 按钮

你现在使用网页编辑器来编辑你的 GitHub 仓库（如果你授权了正确的权限）,并且你在 GitHub 上的提交会触发 GitBook 来构建书本。

常见的错误

1. 书本没有被更新/没有任何的构建。如果你连接了你的 GitHub 仓库至一个 GitBook 项目，但是编辑它的内容却没有触发 GitBook 任何的构建操作。验证 webhook 被正确的添加到了你的 GitHub 仓库中（GitHub 仓库设置->Webhook），如果 webhook 不存在或无效，之后添加它到你书本的设置中。
2. 改变书本的名字/拥有者。如果你把你的书本转移给了新的拥有者，之前的 wehook 会失效，你需要之后重新添加它。