GitBook 集成GitHub

2021-03-02 10:26 更新

GitBook 完美的集成了 GitHub 來托管你書本的源代碼。

連接你的賬號/權限

在集成你的書本和 GitHub 前,你需要授予 GitBook 訪問你的 GitHub 賬號的權限。

在你的 賬號設置 里,使用正確的權限連接你的 GitHub 賬號:

  • 默認的權限:僅僅在登陸的時候訪問你的 GitHub 賬號來驗證你
  • 訪問 webhook:訪問你的 GitHub 賬號來在指定的倉庫中創(chuàng)建 webhook(查看webhooks
  • 訪問公開的倉庫:從網頁編輯器中訪問你的 GitHub 倉庫,你可以很容易的在 GitBook 中編輯你的書本(僅僅公共倉庫)
  • 訪問私有的倉庫:和上面一項目一樣,但是只能訪問私有倉庫

從 GitHub 導入書

創(chuàng)建一本新書的時候,GitHub 標簽頁讓你選擇一個 GitHub 倉庫導入。

新創(chuàng)建的書會使用你倉庫的內容,webhook 也會自動添加。

Webhooks

當你的 GitHub 的倉庫改變時,Webhooks 會通知 GitBook。

如果你的 GitHub 倉庫改變時,GitBook 沒有收到通知,這個問題的主要原因是 webhook。你可以檢查倉庫設置中 webhook 的狀態(tài)。

連接書本和 GitHub 倉庫

當你的 GitHub 賬號正確地連接到你的 GitBook 賬號后,將一本書鏈接至一個倉庫很簡單。

警告:當你在你書本的設置中指定了一個 GitHub 倉庫,這個倉庫會優(yōu)先于 GitBook 的 git 倉庫,這意味著編輯器會直接編輯 GitHub 中的內容。

  1. 打開你書本設置中的 GitHub 部分
  2. 輸入你的倉庫 id(例如:YourGitHubUserName/RepoName)
  3. 保存你的設置
  4. 點擊 Add a deployment webhook 按鈕

你現在使用網頁編輯器來編輯你的 GitHub 倉庫(如果你授權了正確的權限),并且你在 GitHub 上的提交會觸發(fā) GitBook 來構建書本。

常見的錯誤

  1. 書本沒有被更新/沒有任何的構建。如果你連接了你的 GitHub 倉庫至一個 GitBook 項目,但是編輯它的內容卻沒有觸發(fā) GitBook 任何的構建操作。驗證 webhook 被正確的添加到了你的 GitHub 倉庫中(GitHub 倉庫設置->Webhook),如果 webhook 不存在或無效,之后添加它到你書本的設置中。
  2. 改變書本的名字/擁有者。如果你把你的書本轉移給了新的擁有者,之前的 wehook 會失效,你需要之后重新添加它。


以上內容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號