GitHub Syncを有効にする

GitHubリポジトリをGitBookと同期する

このガイドでは、GitHub 上のリポジトリを使って GitBook サイトをセットアップする手順を説明します。

GitHub Sync の設定オプション。

1

サイトで Git Sync を開く

サイトから、サイドバーで Git Sync を開きます。

2

GitHub を接続

同期したいリポジトリにアクセスできる GitHub アカウントを接続します。

次の表示が出た場合 「重複の可能性があるアカウント」 この手順でエラーメッセージが表示された場合、GitHub アカウントがすでに別の GitBook ユーザーアカウントにリンクされていることを意味します。

どのアカウントがリンクされているかを確認するには、このセッションからログアウトし、GitHub でサインインする方法を使ってログインしてください。

GitHub に関連付けられている GitBook アカウントがすでにわかっている場合は、そのユーザーアカウントにログインし、GitHub アカウントのリンクを解除してから（設定で実行）、再度ログインして現在のアカウントをリンクできます。

詳細は トラブルシューティングページ.

3

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

次の項目の下で ソースリポジトリ、ドキュメントが含まれているリポジトリを選択します。GitBook が同期するブランチを選択してください。そのブランチが存在しない場合、GitBook は初回同期時に作成します。

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

4

初回同期の方向を選択

初回同期のソース・オブ・トゥルースを選択します。 方向を入れ替え リポジトリの内容で GitBook の内容を置き換える場合。

GitHub → GitBook で、セクションの内容を置き換えられます。 空のリポジトリを選択した場合、GitBook はリポジトリの空の内容でそのセクションを置き換えられます。

初回同期を開始する前に、リポジトリ、ブランチ、方向を確認してください。置き換え先の内容が安全に置き換えられることを確認してください。

5

プロジェクトディレクトリを設定

ドキュメントがサブディレクトリにある場合は、 プロジェクトディレクトリの下に入力してください。GitBook はサイトの docs.yaml ファイルをこのディレクトリに保存します。ドキュメントが monorepo.

6

スペースをマッピング

次の項目の下で コンテンツのマッピングで、各スペースをリポジトリ内のディレクトリに割り当てます。 ./ プロジェクトディレクトリからの相対パスには / リポジトリのルートからのパスには

7

を使用します。新しくリンクされたスペースは自動的に同期されます。

必要に応じて、エージェント指示ファイル、コミットメッセージテンプレート、またはフォークのプレビューを設定します。

8

サイトを同期

クリックして 同期 して初回同期を開始します。

9

書き込みとコミット

GitBook で変更リクエストをマージして、その変更を GitHub にコミットします。GitHub へのコミットは GitBook にも同期されます。

サイト全体の Git Sync からスペースを除外する

サイトの Git Sync のコンテンツマッピングで、除外したいスペースの横にある削除アイコンをクリックします。その後、そのスペースから Git Sync を設定できます。

サイトにすでに Git Sync がある場合、GitBook はスコープを選択するよう求めます:

• サイト全体の Git Sync にスペースを追加するには、サイトのリポジトリとブランチを選択します。
• Space Git Sync を設定するには、独立したリポジトリとブランチを選択します。

サイトで Git Sync を使用していない場合、GitBook はそのスペースに対して個別に Git Sync を設定します。

単一のスペースに Git Sync を設定するには、同期したいスペースで セットアップ の横にある Git Sync の スペースヘッダーをクリックします。プロバイダー一覧から GitHub Sync.

GitHub 連携を支える GitHub アプリは、現在 GitHub Enterprise Server インスタンスを利用しているお客様にはご利用いただけません。