クイックスタート

Guidebook Cloudを使い始めるための手順を説明します。

1. サインアップ

  1. console.guidebook.dev にアクセス
  2. 「ログイン」ボタンをクリック
  3. GitHubまたはGoogleアカウントでログイン

初回ログイン時は、自動的にユーザーアカウントが作成されます。

2. 組織を作成する

ログイン後、組織を作成します。組織は、リポジトリやメンバーを管理する単位です。

  1. 「組織を作成」ボタンをクリック
  2. 以下の情報を入力：
    • 組織名: 表示名（例: 株式会社Example）
    • スラッグ: URLに使用される識別子（例: example）
  3. 「作成」をクリック

注意: スラッグは後から変更できません。URLに使用されるため、短く分かりやすい名前を推奨します。

3. GitHubと連携する

ドキュメントをGitHubリポジトリから自動デプロイするには、GitHub Appをインストールします。

  1. サイドバーの「設定」→「GitHub」を開く
  2. 「GitHub Appをインストール」をクリック
  3. GitHubの画面で、連携したい組織またはアカウントを選択
  4. アクセスを許可するリポジトリを選択
  5. 「Install」をクリック

インストールが完了すると、選択したリポジトリがGuidebook Cloudに表示されます。

4. リポジトリをインポートする

GitHubとの連携後、ドキュメントリポジトリをインポートします。

  1. サイドバーの「リポジトリ」を開く
  2. 「リポジトリをインポート」をクリック
  3. 連携済みのGitHubリポジトリから選択
  4. ドキュメントのパスを確認（book.json から自動検出されます）
  5. 「インポート」をクリック

インポート後、自動的に最初のビルドが開始されます。

5. ドキュメントを確認する

ビルドが完了すると、ドキュメントが公開されます。

https://guidebook.dev/{org-slug}/{repository-slug}/{branch}/

例: https://guidebook.dev/example/user-guide/main/

ドキュメントの構成

Guidebook Cloudは、HonKit/GitBook互換のドキュメント構成をサポートしています。

必要なファイル

docs/
├── README.md      # トップページ
├── SUMMARY.md     # 目次
├── chapter1.md    # 各ページ
└── chapter2/
    ├── README.md
    └── section1.md

SUMMARY.md の例

# 目次

* [はじめに](README.md)
* [第1章](chapter1.md)
* [第2章](chapter2/README.md)
  * [セクション1](chapter2/section1.md)

次のステップ