コンテンツ設定

追加機能付きで Git 同期を設定する

Git Sync をさらに設定したい場合は、追加できます。 .gitbook.yaml GitBook に Git リポジトリの解析方法を伝えるために、リポジトリのルートにある

.gitbook.yaml

root: ./

​構造:
  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 が有効な場合は、 readme ファイルを作成または変更しないようにしてください GitBook の UI から行うのではなく、競合や重複の問題を避けるために、readme ファイルは GitHub/GitLab リポジトリ内でのみ管理してください。

概要‌

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

./SUMMARY.md

‌# 概要​

## このページのようなページグループを作成するには見出しを使用します​

* [最初のページのタイトル](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 設定ファイルで指定した場合はそのフォルダー内に、そうでなければリポジトリのルートにあります。

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

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

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

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

ページ自体とは異なるタイトルを目次サイドバーに表示したい場合は、任意の ページリンクタイトル を SUMMARY.md ファイル。

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

./SUMMARY.md

# 概要

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

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

• 目次（サイドバー）で

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

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

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