# クイックスタート

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

このガイドの最後には、公開中のドキュメントサイトが完成し、拡張やカスタマイズの準備が整います。

{% stepper %}
{% step %}
**始める**

まず [アカウントを作成する](https://app.gitbook.com/join) 必要があります。そうしてから最初のドキュメントサイトを始められます。

アカウントを作成すると、編集やカスタマイズができる新しいドキュメントサイトが自動的に表示されます。公開する前に、画面上のオプションからサイトへのコンテンツ追加方法を選択してください。

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

<i class="fa-arrow-down">:arrow-down:</i> [このページの「公開」セクションへ移動](#publish-your-documentation)
{% endhint %}
{% endstep %}

{% step %}
**コンテンツを編集する**

GitBookでコンテンツを編集・更新する方法は2つあります。ビジュアルエディタを使う方法と、docs-as-code のワークフローに従う方法です。 **どちらか一方を選んでも、両方を組み合わせても構いません**.

どのワークフローを選んでも、コンテンツは **ブランチベースの編集フロー**を使って編集します。詳細は [コンセプトのページ](/docs/documentation/ja-gitbook-documentation/rissu/concepts.md).

<details>

<summary>ビジュアルエディタを使う</summary>

GitBookのWYSIWYG（見たままを編集）エディタでは、コンテンツを視覚的に編集したり、コンテンツブロックをドラッグして並べ替えたり、作業中に完成イメージを確認したりできます。

このビジュアル編集のワークフローは、コードエディタで作業したくないユーザーや、NotionやGoogle Docsのようなツールを使った経験があるユーザーに最適です。

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

まず、サイドバーでドキュメントサイトを見つけ、その下にある項目をクリックします。これでコンテンツが置かれているスペースに移動します。

クリック **編集** 右上の

クリック **新規追加…** をクリックします。左側の目次でこれを使ってページを追加し、タイトルを付けます。

<div data-with-frame="true"><figure><img src="/files/f505bfb1d9ac3343c59cc4a2a1ffce84fc8a937d" alt="A screenshot of the Editor in the GitBook app, zoomed in to show the menu that lets you add new pages, groups, links and more to a GitBook space."><figcaption></figcaption></figure></div>

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

Webアプリ上部に **エディタ**, **変更** 、 **プレビュー**のタブが表示されます。これらでコンテンツの表示を切り替えます。

クリック **プレビュー** を使うと、デスクトップとモバイルの両方で、変更リクエストの内容がすべて反映されたドキュメントサイトのライブプレビューを確認できます。

<div data-with-frame="true"><figure><img src="/files/7fcde6bb873653363a4ad26a6e906b9c891f554f" alt="A screenshot of the GitBook app with the Preview tab open, showing a docs site being previewed on a mobile-size display"><figcaption></figcaption></figure></div>

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

変更に問題がなければ、右上の **マージ** ボタンをクリックします。

これにより、変更リクエストに含まれるすべての編集内容がコンテンツのメイン版に反映されます。コンテンツが公開中のドキュメントサイトの一部である場合、サイトはすぐに更新されます。

</details>

<details>

<summary>コードベースの編集</summary>

GitHubまたはGitLabのリポジトリとドキュメントを同期すると、コードベースの編集を有効にできます。同期後は、既存の開発環境でドキュメントを編集できます。

このワークフローは、ツールを切り替えたくない技術者や、他のコードと一緒にドキュメントを管理したい人に最適です。

**1. Git Sync を設定する**

サイト作成時にまだGit Syncを設定していない場合は、まずサイドバーでドキュメントサイトを見つけ、その下にあるコンテンツ名をクリックします。これでコンテンツが置かれているスペースに移動します。

クリックして **Git Sync を設定** ボタンを右上でクリックし、指示に従ってスペースを選択したGitリポジトリと同期します。

次へ移動し [Git Sync ページ](/docs/documentation/ja-gitbook-documentation/getting-started/git-sync.md) で詳細を確認できます。

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

スペースをGitリポジトリに同期すると、開発環境内のそのリポジトリからドキュメントのコンテンツを更新できます。

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

{% hint style="info" %}

#### Markdown編集

GitBook は [Markdown編集](/docs/documentation/ja-gitbook-documentation/creating-content/formatting/markdown.md)をサポートしているため、一般的な構文でコンテンツを作成・整形できます。

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

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

できます [変更をプレビュー](/docs/documentation/ja-gitbook-documentation/getting-started/git-sync/github-pull-request-preview.md) できます。

GitHubまたはGitLabのプルリクエストから公開中のドキュメントサイトを確認します。プルリクエストでは、固有のプレビューURL付きのステータスが表示されます。そのステータスの **詳細** をクリックしてプレビューURLを開き、プルリクエストがマージされてサイトが更新されたときの見た目を確認してください。

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

これで準備完了です。プルリクエストをマージすると、GitBookアプリと公開中のドキュメントサイトの両方でコンテンツが更新されます。

GitBookアプリでは、各コミットとマージ済みプルリクエストが、バージョン履歴内の更新としてスペースに同期されます。

<div data-with-frame="true"><figure><img src="/files/364ebf94aed3d60492a9a8f4e608dcff4767d38b" alt="A screenshot of the GitBook app showing the version history side panel open. In the side panel the highlighted entry shows a pull request from GitHub that was merged as part of the history, with a link to view the pull request on GitHub."><figcaption></figcaption></figure></div>

</details>
{% endstep %}

{% step %}
**ドキュメントをカスタマイズする**

<details>

<summary>サイトのナビゲーションを整理する</summary>

APIリファレンス、ヘルプセンター、変更履歴などのコンテンツを、いつでもサイトに追加できます。コンテンツを追加したら、ユーザーが必要なものを簡単に見つけられるように、サイトのナビゲーションバーを整理できます。

次へ移動します [コンセプトのページ](/docs/documentation/ja-gitbook-documentation/rissu/concepts.md) サイトのナビゲーションについて詳しくは

次へ移動します [サイト構造のページ](/docs/documentation/ja-gitbook-documentation/docs-site/site-structure.md) コンテンツの追加について詳しくは

<div data-with-frame="true"><figure><img src="/files/d8057a7409d4f606776e228129344a21dd596f8f" alt="A screenshot of a published docs site hosted on GitBook. The top of the site has a navigation bar, and the cursor is hovering over a drop-down in that bar, with a submenu open below it showing links to more pages"><figcaption></figcaption></figure></div>

</details>

<details>

<summary>ドキュメントサイトの見た目と使い勝手をカスタマイズする</summary>

ドキュメントサイトは初期設定のままでも十分見栄えが良いですが、公開サイトの見た目と使い勝手を変更する多くの設定をカスタマイズすることもできます。

サイトの [ロゴ、色、フォント](/docs/documentation/ja-gitbook-documentation/docs-site/customization/icons-colors-and-themes.md)をカスタマイズしたり、 [サイトセクション](/docs/documentation/ja-gitbook-documentation/docs-site/site-structure/site-sections.md) 、 [バリアント](/docs/documentation/ja-gitbook-documentation/docs-site/site-structure/variants.md)を使ってサイトのナビゲーションバーに項目を追加したり、 [サイトの公開設定](/docs/documentation/ja-gitbook-documentation/docs-site/site-settings.md#audience) などを更新できます。

<div data-with-frame="true"><figure><img src="/files/3a1c4a351a5d555861ebc99949980b8351fc8505" alt="An illustration showing five docs sites hosted in GitBook, each with distinct visual customizations"><figcaption></figcaption></figure></div>

</details>
{% endstep %}

{% step %}
**ドキュメントを公開する**

<details>

<summary>ドキュメントを公開する</summary>

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

サイドバーでサイト名をクリックしてサイトのダッシュボードを開き、次に右上の **公開** をクリックして公開します。

サイトが公開されると、ダッシュボードに公開サイトへのリンクが表示されます。

<div data-with-frame="true"><figure><img src="/files/7c3b3b57e243eeb276211bc97586e596896fd8f6" alt="A screenshot of the GitBook app showing a dashboard for a docs site. The dashboard shows the public URL, site status, site content, some top-level analytics for the site, and other options in tabs along the top of the screen."><figcaption></figcaption></figure></div>

{% hint style="success" %}
公開についてさらに詳しく知りたいですか？ [GitBookでコンテンツを作成して公開する完全ガイド](/docs/guides/editing-and-publishing-documentation/complete-guide-to-publishing-docs-gitbook.md).
{% endhint %}

</details>

<details>

<summary>カスタムドメインを追加する</summary>

デフォルトでは、サイトは次の形式の固有URLで公開されます。

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

これは一部のチームには適しているかもしれませんが、多くのチームは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).

これを行うには、サイドバーでサイト名をクリックしてサイトのダッシュボードを開き、次に **設定** タブを開いて **ドメインとURL**.

<figure><img src="/files/1ce840f61260b1f2315b5638f9b52bfa6d75892b" alt="A screenshot of the GitBook app showing the menu that guides you through the process of setting up a custom domain for your docs site."><figcaption></figcaption></figure>

を選択します。画面上のボタンで希望のオプションを選び、ドメインプロバイダーでDNS設定を行う手順に従ってください。

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

</details>
{% endstep %}
{% endstepper %}

### 次のステップ

<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>

### FAQ

<details>

<summary>GitBookとは？</summary>

GitBookは、チームがブランド付きドキュメントをWebサイトとして作成、レビュー、公開できる、共同作業型のAIネイティブなドキュメントプラットフォームです。GitBookでホストされるドキュメントサイトでは、組み込みのAIアシスタントを利用でき、MCP経由で他のAIツールに接続することもできます。

高度なビジュアルエディタではMarkdownを使ってコンテンツを編集でき、Gitリポジトリと同期して docs as code のワークフローを実現することも、両方を組み合わせることもできます。チームがGitBookをどう使う場合でも、完全なバージョン履歴を備えたGitライクなブランチワークフローを使うため、主要コンテンツを保護しながら、チーム全体での共同作業とフィードバックを促進できます。

</details>

<details>

<summary>GitBookでドキュメントを公開するには？</summary>

GitBookでの公開は、コンテンツの公開準備が整えば簡単です。

1. 新しいドキュメントサイトを作成する（または既存のものを開く）して、公開したいコンテンツを選びます。
2. サイトの対象読者を選びます。 **公開** 設定を使って全員に公開することも、 **共有リンク** または **認証済みアクセス**.
3. （任意）組み込みオプションを使ってブランド、ドメイン、テーマをカスタマイズします。
4. クリック **公開**。おめでとうございます。ドキュメントが公開されました！あとからスペースを追加して、サイトのセクションやバリエーションとして使うこともできます。

詳しくは [クイックスタートガイド](#getting-started) を上で確認するか、 [GitBookでドキュメントを作成・公開する完全ガイド](/docs/guides/editing-and-publishing-documentation/complete-guide-to-publishing-docs-gitbook.md).

</details>

<details>

<summary>GitBookはオープンソースですか？</summary>

GitBook自体はオープンソースではありません。ただし、GitBookの公開ドキュメントプラットフォームは、ドキュメントサイトでドキュメントをホスト・表示するために使われており、これはオープンソースです。 [リポジトリにアクセスして](https://github.com/GitbookIO/gitbook) コードを確認し、変更を送信してレビューを受けることができます。

GitBook自体はオープンソースではありませんが、 **オープンソースプロジェクトはGitBookで無料でドキュメントを公開できます**。チームは [Communityプラン](/docs/documentation/ja-gitbook-documentation/akaunto/plans/community.md) に登録し、 [Sponsored siteプラン](/docs/documentation/ja-gitbook-documentation/akaunto/plans/community/sponsored-site-plan.md)を使ってコンテンツを公開できます。どちらも条件を満たすチームには無料です。

</details>

<details>

<summary>GitBookでサイトとスペースの違いは何ですか？</summary>

GitBookでは、 **ドキュメントサイト** はドキュメント全体のハブであり、対象読者がアクセスできるすべてのコンテンツをホストし、テーマやドメインなどのカスタマイズ可能なオプションを備えています。

各サイトには1つ以上の **スペース**が含まれ、それぞれがサイト内の個別セクションとして機能し、関連コンテンツを整理して、モジュール性と管理のしやすさを高めます。スペースを使うと特定のトピックに共同作業を集中でき、複数のスペースを1つのサイトにまとめて、構成を作成したり、翻訳（ローカライズされたドキュメント向け）や複数製品サポートなどの機能を有効にしたりできます。

</details>

<details>

<summary>GitBookのビジュアルエディタとGit Syncの違いは何ですか？</summary>

GitBookには、ドキュメントを編集する主な方法が2つあります。ビジュアルエディタとGit Syncです。 **ビジュアルエディタ** は、Markdownサポートを備えた従来のユーザーインターフェースを使って、GitBook内で直接コンテンツを作成・編集できる高度なブロックベースのエディタです。コードを直接扱わずに、より直感的で実践的な編集体験を好む人に最適です。

**Git Sync** は、ドキュメントのワークフローをGitリポジトリと統合し、「docs as code」アプローチを可能にします。このオプションは、使い慣れたGitコマンドとワークフローを使って、コードベースと並行してドキュメントを管理したい開発者やチームに最適です。

チームはこれらのワークフローのいずれかを選ぶことも、両方を組み合わせることもできます。どの方法を選んでも、編集は一貫したGitライクなブランチワークフローに従い、完全なバージョン履歴とコンテンツレビューのプロセスが含まれます。これにより、ドキュメント全体での共同作業と品質が向上するだけでなく、主要コンテンツを誤った編集から保護できます。

</details>


---

# Agent Instructions: 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:

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

The question should be specific, self-contained, and written in natural language.
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.
