コンテンツ設定

追加機能を使って Git 同期を設定する

Git Sync をさらに設定したい場合は、 .gitbook.yaml ファイルをリポジトリのルートに追加して、GitBook に Git リポジトリの解析方法を指示できます。

.gitbook.yaml

root: ./

​structure:
  readme: README.md
  summary: SUMMARY.md​

redirects:
  previous/page: new-folder/page.md

ルート

ドキュメントを検索するパスは、デフォルトではリポジトリのルートディレクトリです。GitBook に ./docs フォルダを参照させる方法は次のとおりです:

.gitbook.yaml

root: ./docs/

パスを指定するその他すべてのオプションは、このルートフォルダからの相対パスになります。したがって、root を ./docs/ と定義し、さらに structure.summary を ./product/SUMMARY.mdとして定義すると、GitBook が実際に探すファイルは ./docs/product/SUMMARY.mdです。‌

​構造‌

structure では 2 つのプロパティを受け入れます:‌

• readme: ドキュメントの最初のページです。デフォルト値は ./README.md

• summary: ドキュメントの目次です。デフォルト値は ./SUMMARY.md

これらのプロパティの値は、対応するファイルへのパスです。このパスは「root」オプションからの相対パスです。たとえば、GitBook に ./product フォルダ内の最初のページと summary を参照させる方法は次のとおりです:

.gitbook.yaml

structure:
  readme: ./product/README.md
  summary: ./product/SUMMARY.md

Git Sync が有効な場合は、 readme ファイルを作成または変更しないように注意してください GitBook の UI を通じて。競合や重複の問題を避けるため、readme ファイルは GitHub/GitLab リポジトリ内のみで管理する必要があります。

Summary‌

この summary ファイルは Markdown ファイル（.md）であり、次の構造にする必要があります:

./SUMMARY.md

‌# Summary​

## このように見出しを使ってページグループを作成します​

* [最初のページのタイトル](page1/README.md)
    * [子ページの例](page1/page1-1.md)
    * [別の子ページ](part1/page1-2.md)

* [2 番目のページのタイトル](page2/README.md)
    * [子ページの例](page2/page2-1.md)
    * [別の子ページ](part2/page2-2.md)

## 2 番目のページグループ​

* [別のページ](another-page.md)

カスタム summary ファイルの指定は任意です。デフォルトでは、GitBook は SUMMARY.md という名前のファイルを、設定ファイルで指定されている場合は root フォルダ内で、そうでない場合はリポジトリのルートで探します。

summary を指定しておらず、GitBook が SUMMARY.md ファイルをドキュメントのルートで見つけられない場合、GitBook はフォルダ構造とその配下の Markdown ファイルから目次を推測します。‌

summary の markdown ファイルは、 の鏡像です 目次 あなたの GitBook スペースの。したがって、初回インポート時に summary ファイルが提供されなくても、GitBook はそれを作成し、GitBook エディターでコンテンツを更新するたびに更新します。

このため、同じ Markdown ファイルを SUMMARY.md ファイル内で 2 回参照することはできません。これは、GitBook スペース内で 1 つのページが 2 つの異なる URL に存在することを意味するためです。

目次（サイドバー）のタイトル

ページ自体のタイトルとは別のタイトルを目次のサイドバーに表示したい場合は、任意の ページリンクタイトル という名前のファイルを、設定ファイルで指定されている場合は SUMMARY.md ファイルを定義できます。

Git Sync を使用している場合、ページリンクタイトルはページリンク上で設定します:

./SUMMARY.md

# Summary

* [ページのメインタイトル](page.md "ページリンクタイトル")

引用符内のテキスト（"ページリンクタイトル"）は次で使用されます:

• 目次（サイドバー）内

• 各ページの下部にあるページネーションボタン内

• そのページに追加する相対リンク内

ページリンクタイトルは任意です。手動で追加しない場合、GitBook はデフォルトでページの通常のタイトルをすべての場所で使用します。