> 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 のセットアップ方法と、最初のドキュメントサイトを数分で公開する方法を説明します。

このガイドの শেষেには、公開中のドキュメントサイトができ、拡張やカスタマイズの準備が整います。

{% stepper %}
{% 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>ドキュメントテンプレート</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>これらはサイトのセクションです。ドキュメントテンプレートでは、ホーム、ドキュメント、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 でコンテンツを編集・更新する方法は 2 つあります。ビジュアルエディタを使う方法と、docs-as-code のワークフローに従う方法です。 **どちらか一方を選ぶことも、両方を組み合わせることもできます。** どのワークフローを選んでも、 **ブランチベースの編集フロー**を使ってコンテンツを編集します。詳しくは [Concepts ページ](/docs/documentation/ja-gitbook-documentation/rissu/concepts.md).

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

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

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

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

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

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

変更に満足したら、 **マージ** ボタンを右上隅でクリックします。これにより、変更リクエスト内のすべての編集内容がコンテンツの本番版に反映されます。コンテンツが公開中のドキュメントサイトの一部であれば、サイトはすぐに更新されます。
{% endtab %}

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

**Git Sync を設定する**

1. 同期したいセクションを **コンテンツ** サイドバーの部分から開きます。
2. Git Sync インジケーターの **設定** ボタンをトップバーでクリックします。
3. 選択した Git リポジトリにセクションを同期するための手順に従ってください。 [Git Sync ページ](/docs/documentation/ja-gitbook-documentation/getting-started/git-sync.md) をご覧ください。

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

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

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

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

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

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

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

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

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

{% step %}

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

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

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

**見た目と雰囲気をカスタマイズする**

サイトは初期設定のままでも素晴らしい見た目です。さらに **カスタマイズ**では、独自の [ロゴ、色、フォント](/docs/documentation/ja-gitbook-documentation/docs-site/customization/icons-colors-and-themes.md)を設定し、レイアウトを調整し、 [サイトの公開範囲](/docs/documentation/ja-gitbook-documentation/docs-site/site-settings.md#audience).
{% endstep %}

{% step %}

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

サイトはいつでもクリックひとつで公開できます。

1. 組織からサイトを開く **ホーム**.
2. クリック **公開** をサイトヘッダーで。

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

{% hint style="success" %}
公開についてさらに詳しく知りたいですか？ [GitBook でコンテンツを作成して公開するための完全ガイドをご覧ください](/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 を [カスタムドメイン](/docs/documentation/ja-gitbook-documentation/docs-site/custom-domain.md) または [カスタムサブディレクトリ](/docs/documentation/ja-gitbook-documentation/docs-site/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="/files/b47c174e6fd51629c63b994d670dc1434cbe1ed9">/files/b47c174e6fd51629c63b994d670dc1434cbe1ed9</a></td><td><a href="/pages/e7f961e40a9e3175310b21716bce866be03225d8">/pages/e7f961e40a9e3175310b21716bce866be03225d8</a></td><td><a href="/files/ec74e12270dc907ed3561bf1f6dd258230cf2295">/files/ec74e12270dc907ed3561bf1f6dd258230cf2295</a></td><td><a href="/files/ec74e12270dc907ed3561bf1f6dd258230cf2295">/files/ec74e12270dc907ed3561bf1f6dd258230cf2295</a></td><td></td><td></td><td></td></tr><tr><td><strong>サイトの公開範囲を変更する</strong></td><td>共有リンクや認証済みアクセスで、コンテンツを閲覧できる人を管理します</td><td><a href="/files/fd2ba96fe1ee9324aed2a14f880a303eb4957ed3">/files/fd2ba96fe1ee9324aed2a14f880a303eb4957ed3</a></td><td><a href="/pages/37f11f55f4220a1d169cd8ed543486c55684f5bf#publish-a-docs-site">/pages/37f11f55f4220a1d169cd8ed543486c55684f5bf#publish-a-docs-site</a></td><td><a href="/files/13f092853675ff932305fdefdd5c6ffdb1d102ba">/files/13f092853675ff932305fdefdd5c6ffdb1d102ba</a></td><td></td><td><a href="/files/13f092853675ff932305fdefdd5c6ffdb1d102ba">/files/13f092853675ff932305fdefdd5c6ffdb1d102ba</a></td><td><a href="/files/13f092853675ff932305fdefdd5c6ffdb1d102ba">/files/13f092853675ff932305fdefdd5c6ffdb1d102ba</a></td><td></td></tr><tr><td><strong>自動翻訳を追加する</strong></td><td>ワンクリックで自動更新される翻訳を作成します</td><td><a href="/files/09d1042fd33c37f17e235047a85ad7b8c7671b75">/files/09d1042fd33c37f17e235047a85ad7b8c7671b75</a></td><td><a href="/pages/7f67aba647e0d7c72577043b29a77711dcc60f8d">/pages/7f67aba647e0d7c72577043b29a77711dcc60f8d</a></td><td><a href="/files/529f1497c699578448c29dcd23ba17f75cdafea2">/files/529f1497c699578448c29dcd23ba17f75cdafea2</a></td><td></td><td></td><td><a href="/files/529f1497c699578448c29dcd23ba17f75cdafea2">/files/529f1497c699578448c29dcd23ba17f75cdafea2</a></td><td></td></tr><tr><td><strong>連携をインストールする</strong></td><td>スタックと統合し、強力な連携で機能を拡張します</td><td><a href="/files/255138c5edaa71173412fd5bd600264b2998a1b5">/files/255138c5edaa71173412fd5bd600264b2998a1b5</a></td><td><a href="/pages/71043d094c98fde9931838b59a16dca6fe6f0bfa">/pages/71043d094c98fde9931838b59a16dca6fe6f0bfa</a></td><td><a href="/files/75c70a575719de716328beb648ac2ceabc6a6004">/files/75c70a575719de716328beb648ac2ceabc6a6004</a></td><td></td><td></td><td></td><td><a href="/files/75c70a575719de716328beb648ac2ceabc6a6004">/files/75c70a575719de716328beb648ac2ceabc6a6004</a></td></tr><tr><td><strong>API リファレンスを追加する</strong></td><td>API スペックから、自動更新されるインタラクティブな API リファレンスドキュメントを作成します</td><td><a href="/files/89d97c5c9558d8716806350dfdef57596e63b0d4">/files/89d97c5c9558d8716806350dfdef57596e63b0d4</a></td><td><a href="/pages/8f82fb55bc9bc941e0e9f34aa206234409488ef3">/pages/8f82fb55bc9bc941e0e9f34aa206234409488ef3</a></td><td><a href="/files/2684564247529c54f4fac5dc8310b7e30f43fafa">/files/2684564247529c54f4fac5dc8310b7e30f43fafa</a></td><td></td><td></td><td></td><td></td></tr><tr><td><strong>ドキュメントの分析を追跡する</strong></td><td>組み込みのインサイトを使って成果を測定し、ユーザー行動を把握します</td><td><a href="/files/a86f47574b4d261c7a3b65a784a141e9316ca057">/files/a86f47574b4d261c7a3b65a784a141e9316ca057</a></td><td><a href="/pages/fde014aaa6aebaaa1a909804747fce75f331d76d">/pages/fde014aaa6aebaaa1a909804747fce75f331d76d</a></td><td><a href="/files/51dfcc4c75ac91dd75332d7571efdf5fe387576a">/files/51dfcc4c75ac91dd75332d7571efdf5fe387576a</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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.