トラブルシューティング

GitHub の同期エラーが発生しています

リポジトリ内には readme ファイルのみを作成するようにしてください

Git Sync が有効な場合は、GitBook の UI を通じて readme ファイルを作成しないよう注意してください。GitBook の UI で readme ファイルを作成すると：

• リポジトリ内に重複した README ファイルが作成される

• GitBook と GitHub の間でレンダリングの競合が発生する

• ビルドやデプロイのプロセスが壊れる可能性がある

• 予測不能なファイルの優先順位が発生する

これには、README.md、readme.md、Readme.md、README（拡張子なし）という名前のファイルが含まれます。代わりに、README ファイルは git リポジトリで直接管理するようにしてください。

まだエラーが発生していますか？

次の点を確認してください：

• リポジトリに が README.md ファイル をルートに、または root で指定されたフォルダに .gitbook.yamlあり、それが git リポジトリ内で直接作成されたものであること。このファイルは必須であり、ドキュメントのホームページとして使用されます。詳細については、以下をご参照ください： コンテンツ設定.

• Markdown ファイルに YAML frontmatter がある場合は、 リンターを使って正しい形式になっていることを確認してください。

GitBook が私の docs フォルダを使っていません

既定では、GitBook はリポジトリのルートを開始点として使用します。Markdown ファイルの対象範囲を絞るために、特定のディレクトリを指定できます。詳細については、こちらのドキュメントをご覧ください： コンテンツ設定 詳細はこちら。

GitBook が新しい Markdown ファイルを作成しています

GitBook から同期および編集する際に 既存の Git リポジトリを使用している場合、GitBook は既存のファイルを使う代わりに新しい Markdown ファイルを作成することがあります。これは、GitBook がリポジトリ内に以前から存在していたファイルを上書きしないようにするためです。

リダイレクトが正しく機能していません

リダイレクトを機能させるには、YAML ファイルが正しくフォーマットされている必要があります。インデントや空白の誤りなどがあると、リダイレクトが機能しない原因になります。 YAML ファイルの検証 を行うことで、リダイレクトがスムーズに動作することを確認できます。

リダイレクトを設定する際は、先頭にスラッシュを付けないでください。たとえば、 ./misc/support.md にリダイレクトしようとしても機能しません。

また、あるパスにページが存在する限り、GitBook はそのパスに対するリダイレクト候補を探しません。したがって、古いページを新しいページへリダイレクトする場合は、リダイレクトを機能させるために古いページを削除する必要があります。

私のリポジトリが一覧に表示されません

GitHub リポジトリの場合

GitBook GitHub アプリが正しい場所にインストールされていること（アプリのインストール時に、個人の GitHub か、権限のある任意の組織にインストールするかを選べます）、またアプリに正しいリポジトリ権限を付与していることを確認してください。

GitLab リポジトリの場合

アクセストークンに以下のアクセス権が設定されていることを確認してください：

• api

• read_repository

• write_repository

リポジトリに新しいファイルを追加しても GitBook で何も起こりません

このセクションでは特に、 SUMMARY.md ファイルがすでに存在している

リポジトリに SUMMARY.md ファイルが含まれていない場合、GitBook は最初の同期時に自動的に作成します。つまり、Git sync を設定したあとに少なくとも一度 GitBook からコンテンツを編集していれば、このファイルは GitBook によって自動的に作成されているはずです。

リポジトリを更新して Markdown ファイルを追加または変更したのに、その更新が GitBook に反映されず、サイドバーにも同期中のエラーが表示されない場合、変更したファイルが に SUMMARY.md ファイルのファイルを探します。‌

含まれていない可能性が高いです。これは、ファイルを手動で作成したか、GitBook で編集を行った際に、同期の GitBook から Git へのエクスポート段階で作成されたためかもしれません。

このファイルの内容は GitBook 上の 目次 を反映しており、同期の Git から GitBook へのインポート段階で、目次を再作成したり、リポジトリからの今後の更新を GitBook 上の既存コンテンツと再調整したりするために使用されます。

すべてのファイルが SUMMARY.md ファイルに含まれていることを確認しても、まだ GitBook で何も起こらない場合は、遠慮なく サポートに連絡 してください。

GitHub のプレビューが表示されません

GitHub のプレビューが表示されない場合、GitSync の連携が 2022 年 1 月より前に設定されたことが原因かもしれません。この日付より前に設定された GitSync のバージョンには GitHub プレビューが含まれていません。

PR に対する読み取り専用アクセスを有効にする更新済みの権限リクエストを承認するよう求める通知を受け取っているはずです。

通知を受け取っていない場合は、問題を解決するために新しいバージョンへ更新する必要があります：

1. 組織から GitSync 連携をアンインストールします。

2. 更新された権限を使って新しいバージョンを再インストールします。

GitSync 連携をアンインストールすると、以前接続されていた各スペースで連携を再設定する必要がある点にご注意ください。

サインイン時にアカウントが重複している可能性があります

このエラーは通常、同期の設定に使用した GitHub アカウントが、別の GitBook ユーザーアカウントに既に関連付けられている場合に発生します。

GitHub アカウントがすでにどの GitBook アカウントにリンクされているかを特定するには、次の方法が有効です：

1. 現在の GitBook ユーザーセッションからログアウトします（つまり、 [e-mail])

2. すべての GitHub ユーザーセッションからログアウトします。

3. へ移動します ログインページ.

4. 「GitHub でサインイン」オプションを選択します。

5. GitHub の認証情報を入力します。

6. ログインしたら、 アカウント設定 に移動し、以下のいずれかを行います：

   1. 個人設定の「Third-party Login > GitHub」セクションからアカウントのリンクを解除する

   2. そのアカウントが不要であれば、完全に削除する。

7. そのセッションからログアウトします。

8. 再度ログインし、 [e-mail] GitBook アカウント

9. で Git Sync の設定を再試行します。