ドキュメントパス設定

Guidebook Cloudでは、GitHubリポジトリ内のどのディレクトリをドキュメントとしてビルドするかを指定できます。これにより、モノレポや複雑なプロジェクト構造にも対応できます。

ドキュメントパスとは

ドキュメントパスは、GitHubリポジトリのルートからドキュメントディレクトリへの相対パスです。デフォルトは docs/ です。

自動検出

GitHubリポジトリを選択すると、book.json ファイルの位置が自動的に検出されます。検出された場合、ドキュメントパスのデフォルト値として設定されます。

検出の仕組み

1. リポジトリ内の book.json ファイルを検索
2. 見つかった場合、そのディレクトリをドキュメントパスとして提案
3. 複数見つかった場合、ルートに最も近いものを優先

検出例

設定方法

リポジトリインポート時

リポジトリをインポートする際に、ドキュメントパスを指定できます：

1. 「リポジトリをインポート」をクリック
2. GitHubリポジトリを選択（自動検出が実行されます）
3. 「ドキュメントパス」フィールドを確認・編集
4. 「インポート」をクリック

既存リポジトリの変更

既存のリポジトリのドキュメントパスを変更するには：

1. リポジトリの設定ページを開く
2. 「ドキュメントパス」を編集
3. 「保存」をクリック

注意: パスを変更すると、次回ビルド時から新しいパスが使用されます。

パスの形式

基本形式

{ディレクトリ名}/

末尾のスラッシュは省略可能です。

例

モノレポでの使用

モノレポ（複数のパッケージを含むリポジトリ）では、パッケージごとに異なるドキュメントを管理できます。

構成例

my-monorepo/
├── packages/
│   ├── frontend/
│   │   └── docs/          # フロントエンドのドキュメント
│   ├── backend/
│   │   └── docs/          # バックエンドのドキュメント
│   └── shared/
│       └── docs/          # 共通ライブラリのドキュメント
└── docs/                  # プロジェクト全体のドキュメント

複数リポジトリの登録

同じGitHubリポジトリから、パスの異なる複数のGuidebookリポジトリを作成できます：

必要なファイル

指定したドキュメントパスには、以下のファイルが必要です：

{docs-path}/
├── README.md      # 必須: トップページ
├── SUMMARY.md     # 必須: 目次
└── ...            # その他のMarkdownファイル

README.md

ドキュメントのトップページとして表示されます。

SUMMARY.md

ドキュメントの目次を定義します。このファイルに記載されたページのみがビルド対象となります。

# 目次

* [はじめに](README.md)
* [インストール](installation.md)
* [設定](configuration.md)

トラブルシューティング

ビルドが失敗する

• ドキュメントパスが正しいか確認
• README.md と SUMMARY.md が存在するか確認
• パスの大文字小文字が正しいか確認（GitHubは大文字小文字を区別します）

ファイルが見つからない

• SUMMARY.md 内のパスが正しいか確認
• ファイルがGitにコミットされているか確認