GitBook 集成GitHub

GitBook 完美的集成了 GitHub 來(lái)托管你書(shū)本的源代碼。

連接你的賬號(hào)/權(quán)限

在集成你的書(shū)本和 GitHub 前，你需要授予 GitBook 訪問(wèn)你的 GitHub 賬號(hào)的權(quán)限。

在你的 賬號(hào)設(shè)置 里，使用正確的權(quán)限連接你的 GitHub 賬號(hào)：

• 默認(rèn)的權(quán)限：僅僅在登陸的時(shí)候訪問(wèn)你的 GitHub 賬號(hào)來(lái)驗(yàn)證你
• 訪問(wèn) webhook：訪問(wèn)你的 GitHub 賬號(hào)來(lái)在指定的倉(cāng)庫(kù)中創(chuàng)建 webhook（查看webhooks）
• 訪問(wèn)公開(kāi)的倉(cāng)庫(kù)：從網(wǎng)頁(yè)編輯器中訪問(wèn)你的 GitHub 倉(cāng)庫(kù)，你可以很容易的在 GitBook 中編輯你的書(shū)本（僅僅公共倉(cāng)庫(kù)）
• 訪問(wèn)私有的倉(cāng)庫(kù)：和上面一項(xiàng)目一樣，但是只能訪問(wèn)私有倉(cāng)庫(kù)

從 GitHub 導(dǎo)入書(shū)

創(chuàng)建一本新書(shū)的時(shí)候，GitHub 標(biāo)簽頁(yè)讓你選擇一個(gè) GitHub 倉(cāng)庫(kù)導(dǎo)入。

新創(chuàng)建的書(shū)會(huì)使用你倉(cāng)庫(kù)的內(nèi)容，webhook 也會(huì)自動(dòng)添加。

Webhooks

當(dāng)你的 GitHub 的倉(cāng)庫(kù)改變時(shí)，Webhooks 會(huì)通知 GitBook。

如果你的 GitHub 倉(cāng)庫(kù)改變時(shí)，GitBook 沒(méi)有收到通知，這個(gè)問(wèn)題的主要原因是 webhook。你可以檢查倉(cāng)庫(kù)設(shè)置中 webhook 的狀態(tài)。

連接書(shū)本和 GitHub 倉(cāng)庫(kù)

當(dāng)你的 GitHub 賬號(hào)正確地連接到你的 GitBook 賬號(hào)后，將一本書(shū)鏈接至一個(gè)倉(cāng)庫(kù)很簡(jiǎn)單。

警告：當(dāng)你在你書(shū)本的設(shè)置中指定了一個(gè) GitHub 倉(cāng)庫(kù)，這個(gè)倉(cāng)庫(kù)會(huì)優(yōu)先于 GitBook 的 git 倉(cāng)庫(kù)，這意味著編輯器會(huì)直接編輯 GitHub 中的內(nèi)容。

1. 打開(kāi)你書(shū)本設(shè)置中的 GitHub 部分
2. 輸入你的倉(cāng)庫(kù) id（例如：YourGitHubUserName/RepoName）
3. 保存你的設(shè)置
4. 點(diǎn)擊 Add a deployment webhook 按鈕

你現(xiàn)在使用網(wǎng)頁(yè)編輯器來(lái)編輯你的 GitHub 倉(cāng)庫(kù)（如果你授權(quán)了正確的權(quán)限）,并且你在 GitHub 上的提交會(huì)觸發(fā) GitBook 來(lái)構(gòu)建書(shū)本。

常見(jiàn)的錯(cuò)誤

1. 書(shū)本沒(méi)有被更新/沒(méi)有任何的構(gòu)建。如果你連接了你的 GitHub 倉(cāng)庫(kù)至一個(gè) GitBook 項(xiàng)目，但是編輯它的內(nèi)容卻沒(méi)有觸發(fā) GitBook 任何的構(gòu)建操作。驗(yàn)證 webhook 被正確的添加到了你的 GitHub 倉(cāng)庫(kù)中（GitHub 倉(cāng)庫(kù)設(shè)置->Webhook），如果 webhook 不存在或無(wú)效，之后添加它到你書(shū)本的設(shè)置中。
2. 改變書(shū)本的名字/擁有者。如果你把你的書(shū)本轉(zhuǎn)移給了新的擁有者，之前的 wehook 會(huì)失效，你需要之后重新添加它。