コンテンツ設定

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

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のファイルを探します。‌

​構造‌

構造は 2 つのプロパティを受け付けます。‌

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

• summary: ドキュメントの目次です。既定値は ./SUMMARY.md

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

.gitbook.yaml

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

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

要約‌

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

./SUMMARY.md

‌# 要約​

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

* [1 ページ目のタイトル](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)

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

要約を指定せず、かつ GitBook が SUMMARY.md docs のルートにファイルを見つけられない場合、GitBook はフォルダ構造と以下の Markdown ファイルから目次を推測します。‌

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

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

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

ページ本体のタイトルとは異なるタイトルを目次サイドバーに表示したい場合は、任意の ページリンクタイトル という名前のファイルを SUMMARY.md ファイルを含むサブディレクトリを指すように設定してください。

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

./SUMMARY.md

# Summary

サイドバーのナビゲーションとページ本体で異なるタイトルを定義できます:

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

• 目次（サイドバー）内

• 各ページ下部のページ送りボタン内

• そのページに追加した相対リンク内

ページリンクタイトルは任意です。手動で追加しない場合、GitBook は既定でページの標準タイトルをあらゆる場所で使用します。