概要

クイックスタート — 3 分

GitHub からドキュメントサイトを 3 つの簡単なステップで作成します。

ステップ 1: GitHub でサインイン

  1. docsbook.io を開きます
  2. "Create my docs site" ボタンをクリックします
  3. "Sign in with GitHub" をクリックします
  4. Docsbook が GitHub プロフィールにアクセスすることを許可します

✅ Docsbook は、公開リポジトリ とプロフィール名のみにアクセスします。

ステップ 2: リポジトリを選択する

サインインすると、公開リポジトリのリストが表示されます。

  1. ドキュメントがあるリポジトリを見つけます
  2. それをクリックします
  3. Docsbook はワークスペースを作成します

ステップ3: サイトの表示

ドキュメントはすでに以下のURLで利用可能です:

docsbook.io/{your-name}/{repo}

例:

  • GitHub: github.com/alice/my-project
  • Docsbook: docsbook.io/alice/my-project

完了!🎉

ドキュメントサイトは公開されました。GitHub と自動的に同期されます。

何が次に?

  • GitHubでドキュメントを更新する → サイトに自動的に反映されます
  • カスタムドメインを設定する (プレミアム)
  • 他の言語への翻訳を有効にする (プレミアム)
  • 「Powered by Docsbook」バッジを非表示にする (プレミアム)

追加ガイド: