コンテンツの設定

追加機能を使って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のファイルを探します。

​構成（Structure）‌

structureは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）‌

この summary ファイルはMarkdownファイル（.md）で、次の構造であるべきです：

./SUMMARY.md

‌# Summary​

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

* [First page’s title](page1/README.md)
    * [Some child page](page1/page1-1.md)
    * [Some other child page](part1/page1-2.md)

* [Second page’s title](page2/README.md)
    * [Some child page](page2/page2-1.md)
    * [Some other child page](part2/page2-2.md)

## 二つ目のページグループ​

* [Another page](another-page.md)

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

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

summaryのMarkdownファイルは のミラーであり、 の目次 です。したがって、初回インポート時にsummaryファイルが提供されていなくても、GitBookは作成および/またはGitBookエディタでコンテンツを更新するたびにそれを更新します。

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

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

ページのタイトルをページ本体とは異なるものにしたい場合は、オプションの ページリンクのタイトル という名前のファイルを探します SUMMARY.md CODE_OF_CONDUCT.md

を定義できます。

./SUMMARY.md

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

# Summary

* [Page main title](page.md "Page link title")引用符内のテキスト（"Page link title"

• ）は次で使用されます：

• 目次（サイドバー）で

• 各ページ下部のページネーションボタンで

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

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

​リダイレクト（Redirects） .gitbook.yaml リダイレクトを使うと、 設定ファイルでリダイレクトを定義できます。パスは「root」オプションを基準とします。たとえば、過去のURLにアクセスするユーザーを /help から新しいURLの

.gitbook.yaml

root: ./

redirects:
  /support

へリダイレクトするようGitBookに指示する例は次のとおりです： サイトリダイレクト help: support.md

スペースの設定ファイルで定義したリダイレクトは対応するスペースに限定されます。サイト全体、スペースをまたいで適用されるため、ほとんどの場合は、より広域に適用されるものを作成することを推奨します（例えば、サーバー側の設定など）。（注：原文が一部省略されているため用途に合わせて補ってあります）