トラブルシューティング

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フロントマターがある場合は、必ず リンターarrow-up-rightを使って有効か確認してください。

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

デフォルトでは、GitBookはリポジトリのルートを開始ポイントとして使用します。Markdownファイルのスコープを限定するために特定のディレクトリを指定できます。詳細は私たちのドキュメントの コンテンツ設定 を参照してください。

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

既存のGitリポジトリと同期してGitBookから編集する際、 GitBookは既存のファイルを使用せずに新しいMarkdownファイルを作成することがあります。これは、GitBookがリポジトリに元々存在していたファイルを上書きしないようにするために行われます。

リダイレクトが正しく動作しない

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

リダイレクトを設定する際は、先頭にスラッシュを追加しないでください。例えば、 ./misc/support.md へのリダイレクトは動作しません。

また、あるパスにページが存在する限り、GitBookはリダイレクトの有無を探さないことに注意することも重要です。したがって、古いページから新しいページへのリダイレクトを設定する場合は、リダイレクトを機能させるために古いページを削除する必要があります。

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

GitHubリポジトリの場合

GitBook GitHubアプリが正しい場所にインストールされていることを確認してください(アプリをインストールする際、個人のGitHubにインストールするか、権限のある組織にインストールするかを選択できます)およびアプリに正しいリポジトリ権限が付与されていることを確認してください。

GitLabリポジトリの場合

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

  • api

  • read_repository

  • write_repository

リポジトリに新しいファイルを追加してもGitBookで何も起きない

circle-exclamation

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

に一覧表示されていません

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

すべてのファイルが SUMMARY.md ファイルに含まれていることを確認した後でもGitBookで何も起きない場合は、遠慮なく サポートに連絡してくださいarrow-up-right 支援を受けるために。

GitHubプレビューが表示されない

GitHubプレビューが表示されない場合、GitSync統合が2022年1月以前に構成されている可能性があります。この日以前に構成されたGitSyncのバージョンにはGitHubプレビューが含まれていません。

PRへの読み取り専用アクセスを有効にするための更新された権限要求を承認するよう求める通知を受け取っているはずです。

通知を受け取っていない場合は、トラブルシューティングのために新しいバージョンに更新する必要があります:

  1. 組織からGitSync統合をアンインストールしてください。

  2. 更新された権限で新しいバージョンを再インストールしてください。

GitSync統合をアンインストールすると、以前接続されていたスペースごとに統合の再構成が必要になることに注意してください。

サインイン時のアカウント重複の可能性

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

GitHubアカウントが既にリンクされているGitBookアカウントを特定する良い方法は:

  1. 現在のGitBookユーザーセッション(例: name@email.com)

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

  3. に移動してください ログインページarrow-up-right.

  4. 「Sign in with GitHub」オプションを選択してください。

  5. GitHubの資格情報を入力してください。

  6. ログインしたら、に移動してください アカウント設定arrow-up-right そして次のいずれかを行ってください:

    1. 個人設定の「サードパーティログイン > GitHub」セクションでアカウントの連携を解除する

    2. 不要であればアカウントを完全に削除する

  7. セッションからログアウトしてください。

  8. あなたの name@email.com GitBookアカウントで再ログインしてください。

  9. もう一度Git Syncの設定を試してください。

最終更新

役に立ちましたか?