GitHub Syncを有効にする

GitBook向けのGitHub連携を設定して認可します

はじめに

GitHub リポジトリと同期したいスペースで、 スペースヘッダー 右上の 設定を開き、 GitHub Sync.

A GitBook screenshot showing GitHub Sync configuration options
GitHub Sync の設定オプション。

GitHub で認証する

GitHub Sync を初めて設定していて、まだ GitHub アカウントを連携していない場合は、Git Sync の設定を開始するとその操作を求められます。すでにアカウントを連携している場合でも、GitHub 経由での認証が必要になることがあります。

circle-exclamation

GitBook アプリを GitHub アカウントにインストールする

まだ行っていない場合は、 GitBook アプリarrow-up-right を GitHub アカウントに追加するよう求める案内が表示されます。

GitHub のポップオーバーに従い、必要に応じて GitBook に特定のリポジトリ権限を与えるか、すべてのリポジトリへのアクセスを許可してください。

リポジトリとブランチを選択する

GitBook のコンテンツと同期したいアカウントおよびリポジトリを選択してください。

circle-info

リポジトリが見つかりませんか? 一覧にリポジトリが見つからない場合は、 GitBook GitHub アプリarrow-up-right を正しいスコープ(つまり個人アカウント、またはリポジトリが存在する GitHub 組織)にインストールしたことを確認してください。また、GitBook GitHub アプリで正しいリポジトリアクセスを設定しているかも確認してください。

正しいリポジトリを選択したら、コミットをどのブランチにプッシュし、どのブランチから同期するかを選んでください。

初回同期を実行する

初めて同期する際は、2 つの方向のどちらかで同期するオプションがあります。

  1. GitBook -> GitHub は、スペースのコンテンツを 選択したブランチへ同期します。空のリポジトリから始める場合や、GitBook のコンテンツをすばやく取り込みたい場合に最適です。

  2. GitHub -> GitBook は、スペースのコンテンツを から 選択したブランチから同期します。リポジトリに既存の Markdown コンテンツがあり、それを GitBook に取り込みたい場合に最適です。

書き込んでコミットする

これで準備完了です。スペースが ライブ編集 モードだった場合、ライブ編集はロックされていることに気づくはずです。これにより、チームの誰かが GitBook で 変更リクエスト をマージしたときに、コンテンツをリポジトリへ確実に同期できます。

GitBook で編集すると、変更リクエストがマージされるたびに、選択した GitHub ブランチへコミットされます。

GitHub にコミットすると、そのたびに各コミットが履歴コミットとして GitBook スペースに同期されます。

circle-exclamation

最終更新

役に立ちましたか?