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

最終更新

役に立ちましたか?