クイックスタート

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

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

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

はじめに

必要なのはアカウントを作成することです。最初のドキュメントサイトを使い始める前に必要です。

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

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

このページの「公開」セクションへ移動

コンテンツを編集する

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

どちらのワークフローを選んでも、コンテンツは ブランチベースの編集フローを使って編集します。詳しくはコンセプトページ.

ビジュアルエディターを使う

GitBook の WYSIWYG エディターを使うと、視覚的にコンテンツを編集でき、コンテンツブロックをドラッグして並べ替えながら、作業中に見た目を確認できます。

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

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

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

クリック編集右上の

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

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.

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

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

クリック プレビュー 変更リクエスト内のすべての変更を適用した場合に、ドキュメントサイトがデスクトップとモバイルの両方でどのように表示されるかをライブプレビューで確認できます。

A screenshot of the GitBook app with the Preview tab open, showing a docs site being previewed on a mobile-size display

3. 変更をマージする

変更に満足したら、右上隅の マージ ボタンをクリックします。

これにより、変更リクエスト内のすべての編集内容でコンテンツのプライマリバージョンが更新されます。コンテンツが公開中のドキュメントサイトの一部であれば、サイトはすぐに更新されます。

コードベースの編集

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

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

1. Git Sync をセットアップする

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

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

次へ移動し、 Git Sync のページで詳細を確認できます。

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

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

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

Markdown編集

GitBook は Markdown編集をサポートしているので、一般的な構文を使ってコンテンツを作成・整形できます。

GitBook の標準ブロックはすべて、Markdown 構文を使って記述および整形できます。

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

いつでも変更をプレビューするを GitHub または GitLab のプルリクエストから公開中のドキュメントサイトで確認できます。

プルリクエスト内では、一意のプレビュー URL を含むステータスが表示されます。そのステータスの詳細をクリックするとプレビュー URL が開き、プルリクエストがマージされてサイトが更新されたときに、サイトがどのように表示されるか確認できます。

4. 変更をマージする

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

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

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.

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

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

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

次へ移動しますコンセプトページで、サイトナビゲーションの詳細を確認できます。

次へ移動しますサイト構造のページで、サイトへのコンテンツ追加について詳しく確認できます。

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

ドキュメントサイトの見た目をカスタマイズする

ドキュメントサイトはそのままでも見栄えよく表示されますが、公開サイトの見た目を変える多くの設定をカスタマイズすることもできます。

サイトのロゴ、色、フォントをカスタマイズしたり、サイトセクション、バリアントを使ってサイトのナビゲーションバーに項目を追加したり、サイトの公開範囲設定など、さまざまな項目を変更できます。

An illustration showing five docs sites hosted in GitBook, each with distinct visual customizations

ドキュメントを公開する

ドキュメントを公開

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

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

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

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.

公開についてさらに詳しく知りたいですか？ GitBook でコンテンツを作成・公開する完全ガイド.

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

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

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

これは一部のチームには適しているかもしれませんが、多くのチームは URL を次のいずれかに変更します。カスタムドメインまたはカスタムサブディレクトリ.

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

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.

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

DNS 変更が反映されるまで最大 48 時間かかる場合がありますが、通常はもっと早く伝播します。

次のステップ

チームを招待して共同作業する

チームメンバーを組織に追加し、権限を設定する

サイトの公開範囲を変更する

共有リンクと認証済みアクセスで、コンテンツを閲覧できるユーザーを管理する

自動翻訳を追加する

ワンクリックで翻訳を作成し、自動的に更新する

連携をインストールする

スタックと統合し、強力な連携で機能を拡張する

API リファレンスを追加する

API 仕様から、自動更新される対話型の API リファレンスドキュメントを作成する

ドキュメントの分析を追跡する

組み込みのインサイトを使って成果を測定し、ユーザーの行動を理解する

よくある質問

GitBook とは何ですか？

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

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

GitBook でドキュメントを公開するにはどうすればよいですか？

コンテンツを公開できる状態になれば、GitBook での公開は簡単です：

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

詳しくはクイックスタートガイドをご覧いただくか、 GitBook でドキュメントを作成・公開する完全ガイド.

GitBook はオープンソースですか？

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

GitBook 自体はオープンソースではありませんが、 オープンソースプロジェクトは GitBook で無料でドキュメントを公開できます。チームは Community プランに申し込み、 Sponsored site プランを使ってコンテンツを公開できます。どちらも条件を満たすチームには無料です。

GitBook における site と space の違いは何ですか？

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

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

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

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

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

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

最終更新 2 か月前

役に立ちましたか？