コンテンツ設定

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。

モノレポでは、 root は、リポジトリのルートではなく、同期されたスペースのプロジェクト ディレクトリを基準に解決されます。パスベースの設定は、そのスペースの同期範囲内でのみ適用されます。兄弟ディレクトリやリポジトリ レベルのフォルダーが、他のスペースで自動的に利用可能になるわけではありません。複数スペースのリポジトリ構成については、 モノレポ.

構造

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 ではなく、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)

カスタム summary ファイルの指定は任意です。既定では、GitBook は次の名前のファイルを探します SUMMARY.md あなたの root フォルダー内を、設定ファイルで指定している場合はそこから、そうでない場合はリポジトリのルートから検索します。

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

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

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

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

ページのタイトルを、ページ本体とは別に目次サイドバーで別のものにしたい場合は、任意の ページリンクタイトル あなたの SUMMARY.md ファイルを定義できます。

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

./SUMMARY.md

# 要約

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

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

• 目次（サイドバー）で

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

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

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