コンテンツ設定
コードを使ってGit Syncを設定する
Git Sync は 3 つのファイルを使用します。必要な Git Sync の部分を制御するファイルを選択してください:
gitbook-docs.yamlサイトを構成し、スペースをリポジトリのディレクトリにマッピングします。.gitbook.yamlGitBook が 1 つのスペースのコンテンツをどのように読み取るかを構成します。SUMMARY.mdスペースのナビゲーションを定義します。
gitbook-docs.yaml でサイトを構成する
gitbook-docs.yaml サイト全体を構成します。これは Git Sync プロジェクト ディレクトリにあります。GitBook は、a を設定しない場合、リポジトリのルートを使用します プロジェクトディレクトリ.
使用 gitbook-docs.yaml を使用してサイト構造を定義し、各スペースをディレクトリにマッピングします。各項目は site.structure には安定した キーがあります。スペースの content.directory はそのリポジトリ ディレクトリを設定します。サイト内のスペースがサイトのリポジトリと同期しない場合、その content.directory が null.
キーはスペースを識別します
Git Sync は各スペースとセクションをその キーではなく、タイトル、パス、ディレクトリではなく、その gitbook-docs.yaml で識別します。キーは、GitBook が次の同期までに
スペースの キー を変更すると、そのスペースが置き換えられます。 GitBook は古いキーを削除されたものとして扱い、新しいキーを新しいスペースとして扱います。新しいスペースを作成し、マッピングされたディレクトリからコンテンツをインポートし、元のスペースは組織内に残したままサイトから切り離します。
ページは戻ってきますが、新しいスペース ID を持つ別のスペースになります。古い ID を参照するリンク、カード、API 呼び出しは解決されなくなり、リポジトリではなく GitBook 内にのみ存在するものは元のスペースに残ります。
元のキーを復元しても、これは元に戻りません。別の新しいスペースが作成され、そこにインポートされます。
エントリを最初に作成するとき、キーは自由に選んで問題なく、GitBook はサイト コンテンツのマッピングを保存するときに自動生成します。スペースが公開されたら、そのキーは永久的なものとして扱ってください:
スペースの名前を変更するには、その
titleを変更します。キーはそのままです。スペースの URL を変更するには、その
pathを変更します。キーはそのままです。
この例では、英語とフランス語のスペースを別々のディレクトリにマッピングしています:
.gitbook.yaml でスペースを構成する
.gitbook.yaml 1 つのスペースを構成します。これはそのスペースにマッピングされたディレクトリにあります。コンテンツのルート、最初のページ、ナビゲーション ファイル、リダイレクトを設定するために使用します。
主な設定は次のとおりです:
ルートGitBook が読み取るディレクトリを設定します。既定値は./.structure.readme最初のページを設定します。既定値はREADME.md.structure.summaryナビゲーション ファイルを設定します。既定値はSUMMARY.md.リダイレクトスペース内で古いパスを新しいパスにマッピングします。
典型的な構成は次のとおりです:
コンテンツ ルートを設定する
設定する ルート スペースのコンテンツがサブディレクトリ内にある場合:
〜内のパスは .gitbook.yaml に対する相対パスです ルート。〜を使うと root: ./docs/, structure.summary: ./product/SUMMARY.md は次に解決されます ./docs/product/SUMMARY.md.
モノレポでは、 ルート はマッピングされたスペース ディレクトリ内にのみ適用されます。兄弟ディレクトリは利用できるようになりません。複数スペースのリポジトリ構成については、 モノレポ.
最初のページとナビゲーション ファイルを設定する
使用 structure.readme 、 structure.summary カスタム ファイル パスを設定するには:
Git Sync が有効な場合は、 README.md リポジトリ内のファイルを管理してください。GitBook で編集すると、競合や重複ページが発生する可能性があります。
リダイレクトを構成する
スペース レベルのリダイレクトを .gitbook.yamlで構成します。リダイレクト パスはそのスペース内でのみ適用されます。
GitBook アプリでは、サイト レベルのリダイレクトも管理できます。参照: サイトのリダイレクト.
SUMMARY.md でナビゲーションを構成する
SUMMARY.md スペースの目次を定義します。GitBook は、それを構成済みの ルート ディレクトリで探します。
GitBook が SUMMARY.mdを見つけられない場合、フォルダと Markdown ファイルからナビゲーションを推測します。GitBook は SUMMARY.md GitBook でナビゲーションを変更すると、作成または更新します。
ページ グループには見出しを、子ページにはネストされたリンクを使用します:
各 Markdown ファイルは〜に 1 回だけ表示できます SUMMARY.md。1 つのページが 1 つのスペースで持てる URL は 1 つだけです。
ナビゲーション ラベルを設定する
ナビゲーション ラベルがページ タイトルと異なる場合は、ページリンクのタイトルを追加します:
GitBook はサイドバー、ページ送り、相対リンクでページリンクのタイトルを使用します。指定しない場合、GitBook はページ タイトルを使用します。
最終更新
役に立ちましたか？