> For the complete documentation index, see [llms.txt](https://gitbook.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook.com/docs/documentation/ja-gitbook-documentation/getting-started/quickstart.md).

# クイックスタート

GitBook をすぐに使い始めて、数分で最初のドキュメントサイトを公開しましょう

このクイックスタートガイドでは、GitBook のセットアップ方法と、数分で最初のドキュメントサイトを公開する方法を説明します。

このガイドの最後まで進めば、公開中のドキュメントサイトができ、拡張やカスタマイズの準備が整います。

{% stepper %}
{% step %}

#### コーディングエージェントでセットアップする

コーディングエージェントの場合は、次の手順に従ってください [GitBook をセットアップする](https://gitbook.com/docs/documentation/ja-gitbook-documentation/setup.md)。GitBook の接続、サポートを受ける人自身が行う必要のある手順、サイトの公開について説明しています。

セットアップをエージェントに任せるには、このプロンプトを貼り付けてください：&#x20;

{% prompt description="Set up GitBook" %}

```markdown
https://gitbook.com/docs/setup.md に従って、GitBook をセットアップしてください。
```

{% endprompt %}

GitBook アプリを使ってこのガイドに沿っている場合は、次の手順に進んでください。
{% endstep %}

{% step %}

#### アカウントを作成する

[アカウントを作成](https://app.gitbook.com/join) して、最初のドキュメントサイトを始めましょう。
{% endstep %}

{% step %}

#### 最初のサイトを作成する

1. 組織の **ホーム**で、サイドバーの「サイト」の横にある **+** をクリックします。 **サイト** の横にある
2. 訪問者に認識しやすい名前をサイトにつけましょう。
3. クリックします **作成**.
   {% endstep %}

{% step %}

#### 開始方法を選択する

GitBook が新しいサイトへようこそと案内し、どのように始めたいかを尋ねます。

<table><thead><tr><th width="200">開始点</th><th>おすすめ</th></tr></thead><tbody><tr><td><strong>Docs テンプレート</strong></td><td>プレースホルダーのセクションが用意された、すぐ使えるドキュメントレイアウトから始めます。完全なサイトが動作する様子を最も早く確認できる方法です。</td></tr><tr><td><strong>インポート</strong></td><td>オンラインのドキュメント、Markdown、または HTML から既存コンテンツを取り込みます。</td></tr><tr><td><strong>OpenAPI</strong></td><td>OpenAPI 仕様から、対話型の API リファレンスドキュメントを生成します。</td></tr><tr><td><strong>空白</strong></td><td>空のセクションから始めて、一から作成します。</td></tr><tr><td><strong>Git と同期する</strong></td><td>GitHub または GitLab のリポジトリとドキュメントを同期します。</td></tr></tbody></table>

また、GitBook で既に作業しているコンテンツがある場合は、組織の既存コンテンツから選ぶこともできます。

このガイドではテンプレートの方法をたどります：

1. 「 **ドキュメントテンプレート** をクリックし、プレビューを確認します。
2. 「 **ドキュメントテンプレートを使用** をクリックして適用します。
   {% endstep %}

{% step %}

#### 新しいサイトを見てみる

サイトは未公開の状態で開くため、公開前にすべてを編集、カスタマイズ、プレビューできます。サイドバーには次のものが表示されます：

<table><thead><tr><th width="160">サイドバー領域</th><th>内容</th></tr></thead><tbody><tr><td><strong>サイトヘッダー</strong></td><td>サイト名、公開ステータス、 <strong>プレビュー</strong> と <strong>公開</strong> のボタンが表示されます。</td></tr><tr><td><strong>全般</strong></td><td><strong>概要</strong>, <strong>変更リクエスト</strong>, <strong>サイト構成</strong>、 <strong>設定</strong>.</td></tr><tr><td><strong>ツール</strong></td><td><strong>スタイルガイド</strong>, <strong>カスタマイズ</strong>, <strong>分析</strong>、 <strong>拡張</strong>.</td></tr><tr><td><strong>コンテンツ</strong></td><td>サイトのセクションです。Docsテンプレートでは、「ホーム」「ドキュメント」「APIリファレンス」「変更履歴」「ヘルプセンター」が含まれます。 <strong>コンテンツ</strong> ヘッダーのアイコンを使って、セクションを検索、名前変更、追加できます。</td></tr></tbody></table>

{% hint style="success" %}
コンテンツはまだ公開されていないため、サイトを公開する前にドキュメントを編集、カスタマイズし、プレビューできます。「 **公開** をクリックすると、すぐに公開されます。

<i class="fa-arrow-down">:arrow-down:</i> [このページの「ドキュメントを公開する」手順にジャンプする](#publish-your-documentation)
{% endhint %}
{% endstep %}

{% step %}

#### コンテンツを編集する

ドキュメントテンプレートには、「 **コンテンツ** 」のセクションにプレースホルダーが用意されています。任意のセクションをクリックして開き、プレースホルダーのコンテンツを確認してください。

GitBook では、ビジュアルエディターを使う方法と、Docs as Code ワークフローに従う方法の2通りでコンテンツを編集・更新できます。 **どちらか一方を選ぶことも、両方を組み合わせて使うこともできます。** どのワークフローを選んでも、 **ブランチベースの編集フロー**を使ってコンテンツを編集します。詳しくは [「コンセプト」ページ](https://gitbook.com/docs/documentation/ja-gitbook-documentation/rifarensu/concepts.md).

{% tabs %}
{% tab title="ビジュアルエディター" icon="hand-pointer" %}
GitBook の WYSIWYG（見たまま編集）エディターでは、コンテンツを視覚的に編集し、コンテンツブロックをドラッグして並べ替えながら、作業中の見た目を確認できます。コードエディターで作業したくない場合や、Notion や Google ドキュメントのようなツールに慣れている場合に最適です。

**変更リクエストでドキュメントを編集する**

1. サイドバーの **コンテンツ** セクションで、「ドキュメント」などのセクションをクリックして開きます。
2. 右上の **編集** をクリックします。変更リクエストが開き、セクションのコンテンツを変更できます。
3. 左側の目次で **新規追加…** > **ページ** をクリックします。
4. 新しいページにタイトルを付けます。

**変更をプレビューする**

ウェブアプリの上部には、 **エディター**, **変更**、 **プレビュー**のタブが表示されます。これらを切り替えて、コンテンツの表示を確認できます。 **プレビュー** をクリックすると、変更リクエスト内のすべての変更を反映したドキュメントサイトの表示を、デスクトップとモバイルの両方で確認できます。

**変更をマージする**

変更内容に問題がなければ、右上の **マージ** ボタンをクリックします。変更リクエストのすべての編集内容が、コンテンツのプライマリバージョンに反映されます。コンテンツが公開中のドキュメントサイトに含まれている場合、サイトはすぐに更新されます。
{% endtab %}

{% tab title="Git Sync" icon="robot" %}
既存の開発環境でコードベースの編集を有効にするには、ドキュメントを GitHub または GitLab リポジトリと同期します。ほかのコードと一緒にドキュメントを管理したい技術ユーザーに最適です。

**Git Sync を設定する**

1. 同期するセクションを、サイドバーの **コンテンツ** から開きます。
2. 上部バーにあるGit Syncインジケーターの **セットアップ** ボタンをクリックします。
3. 手順に沿って、選択したGitリポジトリにセクションを同期します。詳しくは、 [Git Syncのページ](https://gitbook.com/docs/documentation/ja-gitbook-documentation/docs-as-code/git-sync.md) をご覧ください。

**開発環境からドキュメントを編集する**

セクションを Git リポジトリに同期したら：

1. リポジトリを開きます。
2. プルリクエストを作成します。
3. 必要な変更を行います。

{% hint style="info" %}
GitBookは [Markdownでの編集](https://gitbook.com/docs/documentation/ja-gitbook-documentation/kontentsuwosuru/formatting/markdown.md)に対応しているため、一般的な構文を使ってコンテンツを作成・書式設定できます。

GitBook の標準ブロックはすべて、Markdown を使って記述・整形できます。
{% endhint %}

**変更をプレビューする**

GitHubまたはGitLabのプルリクエストから、公開済みドキュメントサイトで [変更をプレビュー](https://gitbook.com/docs/documentation/ja-gitbook-documentation/docs-as-code/git-sync/github-pull-request-preview.md) できます。プルリクエストには、一意のプレビューURLを含むステータスが表示されます。そのステータスの **詳細** をクリックして開くと、マージ後のサイトの表示を確認できます。

**変更をマージする**

プルリクエストをマージすると、GitBook アプリ内と公開中のドキュメントサイトの両方でコンテンツ更新が反映されます。GitBook アプリでは、各コミットとマージされたプルリクエストが、バージョン履歴内の更新としてセクションに同期されます。
{% endtab %}
{% endtabs %}
{% endstep %}

{% step %}

#### ドキュメントをカスタマイズする

**サイトのナビゲーションを整理する**

APIリファレンス、ヘルプセンター、変更履歴など、サイトにいつでもコンテンツを追加できます。また、訪問者が目的の情報を見つけやすいように、サイトのナビゲーションバーを整理できます。セクション、グループ、バリアントについては、 [サイト構成](https://gitbook.com/docs/documentation/ja-gitbook-documentation/manage-your-site/site-structure.md) をご覧ください。

**見た目をカスタマイズする**

サイトは初期状態でも見栄えよく仕上がっていますが、 **カスタマイズ**では、独自の [ロゴ、色、フォント](https://gitbook.com/docs/documentation/ja-gitbook-documentation/manage-your-site/customization/icons-colors-and-themes.md)を設定したり、レイアウトを調整したり、 [サイトの公開範囲](https://gitbook.com/docs/documentation/ja-gitbook-documentation/manage-your-site/site-settings.md#audience).
{% endstep %}

{% step %}

#### ドキュメントを公開する <a href="#publish-your-documentation" id="publish-your-documentation"></a>

いつでもクリック一つでサイトを公開できます。

1. を更新したりできます。 **組織のホームからサイトを開きます。**.
2. クリックします **公開** をサイトヘッダーでクリックします。

サイトが公開されると、 **概要** 画面が更新され、公開中のサイトへのリンクが表示されます。

{% hint style="success" %}
公開について詳しく知りたい場合は、 [GitBookでコンテンツを作成・公開するための完全ガイド](https://gitbook.com/docs/guides/editing-and-publishing-documentation/complete-guide-to-publishing-docs-gitbook.md).
{% endhint %}
{% endstep %}
{% endstepper %}

#### カスタムドメインを追加する

デフォルトでは、サイトは次の形式の一意の URL で公開されます：

{% code title="サイトのデフォルト URL" %}

```
https://[organization-name].gitbook.io/[site-title]
```

{% endcode %}

この設定で問題ないチームもありますが、多くのチームはURLを次のように変更しています： [カスタムドメイン](https://gitbook.com/docs/documentation/ja-gitbook-documentation/publish/custom-domain.md) または [カスタムサブディレクトリ](https://gitbook.com/docs/documentation/ja-gitbook-documentation/publish/custom-domain/setting-a-custom-subdirectory.md).

1. 展開 **設定** サイトのサイドバーで。
2. クリック **ドメインとURL**.
3. 希望するオプションを選択します。
4. ドメインプロバイダーの指示に従って DNS 設定を構成します。

{% hint style="info" %}
DNS の変更が反映されるまで最大 48 時間かかる場合があります。ただし通常はもっと早く伝播します。
{% endhint %}

#### 次のステップ

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="image">カバー画像</th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-type="image">カバー画像（ダーク）</th><th data-hidden data-type="image">カバー画像（ダーク）</th><th data-hidden data-type="image">カバー画像（ダーク）</th><th data-hidden data-type="image">カバー画像（ダーク）</th><th data-hidden data-card-cover-dark data-type="image">カバー画像（ダーク）</th></tr></thead><tbody><tr><td><strong>チームを招待して共同作業できます</strong></td><td>組織にチームメンバーを追加し、権限を設定する</td><td><a href="https://4217681718-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-123daffcaaa78d9872cc99ad659478c6d97c6de3%2F25_12_10_invite_your_team_to_collaborate_1.png?alt=media">25_12_10_invite_your_team_to_collaborate_1.png</a></td><td><a href="https://gitbook.com/docs/documentation/ja-gitbook-documentation/collaborate/member-management/invite-members-to-your-organization.md">メンバーの管理または削除</a></td><td><a href="https://4217681718-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-fd07e38f01279522faf61b71c083505ccb41c051%2F25_12_10_invite_your_team_to_collaborate.png?alt=media">25_12_10_invite_your_team_to_collaborate.png</a></td><td><a href="https://4217681718-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-fd07e38f01279522faf61b71c083505ccb41c051%2F25_12_10_invite_your_team_to_collaborate.png?alt=media">25_12_10_invite_your_team_to_collaborate.png</a></td><td></td><td></td><td></td></tr><tr><td><strong>サイトの公開設定を変更する</strong></td><td>共有リンクと認証済みアクセスで、誰がコンテンツを見られるかを管理する</td><td><a href="https://4217681718-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-f7064cff1c9aa2b8b21a496533e4257e2692a88f%2F25_12_10_change_site_visibility_1.png?alt=media">25_12_10_change_site_visibility_1.png</a></td><td><a href="https://gitbook.com/docs/documentation/ja-gitbook-documentation/publish/publish-a-docs-site.md#publish-a-docs-site">ドキュメントサイトを公開する</a></td><td><a href="https://4217681718-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-a6cb2d0c9e0bfb53580801c20768eacac87459d9%2F25_12_10_change_site_visibility.png?alt=media">25_12_10_change_site_visibility.png</a></td><td></td><td><a href="https://4217681718-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-a6cb2d0c9e0bfb53580801c20768eacac87459d9%2F25_12_10_change_site_visibility.png?alt=media">25_12_10_change_site_visibility.png</a></td><td><a href="https://4217681718-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-a6cb2d0c9e0bfb53580801c20768eacac87459d9%2F25_12_10_change_site_visibility.png?alt=media">25_12_10_change_site_visibility.png</a></td><td></td></tr><tr><td><strong>自動翻訳を追加する</strong></td><td>自動的に更新されるワンクリック翻訳を作成する</td><td><a href="https://4217681718-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-a1584c50b44ab46eec5ed3f0898eeffd2e6bc94d%2F25_12_10_add_auto_translations_1.png?alt=media">25_12_10_add_auto_translations_1.png</a></td><td><a href="https://gitbook.com/docs/documentation/ja-gitbook-documentation/manage-your-site/site-settings.md">サイト設定</a></td><td><a href="https://4217681718-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-5f37c8f0398c9168c41f5c06b3957ae3df682c76%2F25_12_10_add_auto_translations.png?alt=media">25_12_10_add_auto_translations.png</a></td><td></td><td></td><td><a href="https://4217681718-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-5f37c8f0398c9168c41f5c06b3957ae3df682c76%2F25_12_10_add_auto_translations.png?alt=media">25_12_10_add_auto_translations.png</a></td><td></td></tr><tr><td><strong>連携をインストールする</strong></td><td>強力な連携でスタックと統合し、機能を拡張する</td><td><a href="https://4217681718-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-86da4bb2cc94f3a9a1849fdcfbead0c75891e9c9%2F25_12_10_install_integrations_1.png?alt=media">25_12_10_install_integrations_1.png</a></td><td><a href="https://gitbook.com/docs/documentation/ja-gitbook-documentation/manage-your-site/install-an-integration.md">統合のインストールと管理</a></td><td><a href="https://4217681718-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-b20ed0ab68355cdbd6eb8f5d0eb08a67207b42a3%2F25_12_10_install_integrations.png?alt=media">25_12_10_install_integrations.png</a></td><td></td><td></td><td></td><td><a href="https://4217681718-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-b20ed0ab68355cdbd6eb8f5d0eb08a67207b42a3%2F25_12_10_install_integrations.png?alt=media">25_12_10_install_integrations.png</a></td></tr><tr><td><strong>API リファレンスを追加する</strong></td><td>API 仕様から、自動更新される対話型 API リファレンスドキュメントを作成する</td><td><a href="https://4217681718-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-ac12806b3cbcd4be3a3758a21acf8d8109a02343%2F25_12_10_add_an_api_reference_1.png?alt=media">25_12_10_add_an_api_reference_1.png</a></td><td><a href="https://gitbook.com/docs/documentation/ja-gitbook-documentation/kontentsuwosuru/openapi.md">API をドキュメント化する</a></td><td><a href="https://4217681718-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-165161ef7a07d68f272b9ba34596e895f704ee19%2F25_12_10_add_an_api_reference.png?alt=media">25_12_10_add_an_api_reference.png</a></td><td></td><td></td><td></td><td></td></tr><tr><td><strong>ドキュメント分析を追跡する</strong></td><td>組み込みのインサイトを使って成功を測定し、ユーザー行動を把握する</td><td><a href="https://4217681718-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-b583de47e273a882ffa5ea4797456c3787018ee3%2F25_12_10_track_docs_analytics_1.png?alt=media">25_12_10_track_docs_analytics_1.png</a></td><td><a href="https://gitbook.com/docs/documentation/ja-gitbook-documentation/analytics/insights.md">サイト分析</a></td><td><a href="https://4217681718-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FNkEGS7hzeqa35sMXQZ4X%2Fuploads%2Fgit-blob-a2e88c6a0eb12a917de55c439724c76a5ac9bbf0%2F25_12_10_track_docs_analytics.png?alt=media">25_12_10_track_docs_analytics.png</a></td><td></td><td></td><td></td><td></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://gitbook.com/docs/documentation/ja-gitbook-documentation/getting-started/quickstart.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
