クイックスタート
GitBook ですばやくセットアップして、最初のドキュメントサイトを数分で公開しましょう
このクイックスタートガイドでは、GitBook をセットアップし、数分で最初の docs サイトを公開する方法を説明します。
このガイドの最後には、拡張やカスタマイズの準備が整った、公開中のドキュメントサイトが完成しています。
はじめに
必要があります アカウントを作成 最初のドキュメントサイトを始める前に。
アカウントを作成すると、編集やカスタマイズができる新しい docs サイトが自動的に表示されます。画面上のオプションから、公開前にサイトへコンテンツを追加する方法を選んでください。
コンテンツはまだ公開されていないため、公開前に docs サイトを編集、カスタマイズ、プレビューできます。すぐに公開するには 公開 をクリックしてください。
コンテンツを編集する
GitBook でコンテンツを編集・更新する方法は 2 つあります。ビジュアルエディタを使う方法と、docs-as-code ワークフローに従う方法です。 どちらか一方を選ぶことも、両方を組み合わせて使うこともできます.
どのワークフローを選んでも、コンテンツの編集には ブランチベースの編集フローを使用します。詳しくは Concepts ページ.
ビジュアルエディタを使う
GitBook の WYSIWYG（見たまま編集）エディタでは、コンテンツを視覚的に編集したり、コンテンツブロックをドラッグして並べ替えたり、作業しながらコンテンツの見た目を確認したりできます。
このビジュアル編集ワークフローは、コードエディタで作業したくないユーザーや、Notion や Google ドキュメントのようなツールの使用経験があるユーザーに最適です。
1. 変更リクエストで docs を編集する
まず、サイドバーで docs サイトを見つけ、その下にある項目をクリックします。すると、コンテンツが保存されているスペースに移動します。
右上の 編集 をクリックします。すると、スペースのコンテンツを編集できる変更リクエストが開きます。
右上の 新規追加… を左側の目次でクリックしてページを追加し、タイトルを付けます。
2. 変更をプレビューする
Web アプリの上部には、 エディタ, 変更 と プレビューのタブがあります。これらでコンテンツの異なる表示を切り替えます。
右上の プレビュー 変更リクエスト内のすべての変更を反映した docs サイトの見た目を、デスクトップとモバイルの両方でライブプレビューできます。
3. 変更をマージする
変更内容に問題がなければ、 マージ ボタンを右上隅でクリックします。
これにより、変更リクエストで行ったすべての編集がコンテンツのメインバージョンに反映されます。コンテンツが公開中の docs サイトの一部である場合、サイトは直ちに更新されます。
コードベースの編集
ドキュメントを GitHub または GitLab リポジトリと同期すると、コードベースの編集を有効にできます。同期後は、既存の開発環境で docs を編集できます。
このワークフローは、ツールを切り替えたくなく、他のコードと一緒にドキュメントを管理したい技術系ユーザーに最適です。
1. Git Sync を設定する
サイト作成時にまだ Git Sync を設定していない場合は、まずサイドバーで docs サイトを見つけ、その下にあるコンテンツ名をクリックします。すると、コンテンツが保存されているスペースに移動します。
右上の Git Sync を設定 ボタンをクリックし、手順に従ってスペースを選択した Git リポジトリと同期します。
詳しくは Git Sync ページ をご覧ください。
2. 開発環境から docs を編集する
スペースを Git リポジトリと同期すると、そのリポジトリから開発環境内で docs のコンテンツを更新できます。
リポジトリを開き、プルリクエストを作成して、必要な変更を行います。
Markdown 編集
GitBook は対応しています Markdown 編集そのため、一般的な構文を使ってコンテンツを作成し、書式設定できます。
GitBook のすべての標準ブロックは、Markdown 構文を使って記述および書式設定できます。
3. 変更をプレビューする
GitHub または GitLab のプルリクエストから、公開済みの docs サイト上で 変更をプレビュー できます。
プルリクエストでは、一意のプレビュー URL が付いたステータスが表示されます。 詳細 をそのステータス上でクリックすると、プレビュー URL が開き、プルリクエストがマージされてサイトが更新されたときの見た目を確認できます。
4. 変更をマージする
これで準備完了です。プルリクエストをマージすると、コンテンツは GitBook アプリと、公開中であれば docs サイトの両方で更新されます。
GitBook アプリでは、すべてのコミットとマージ済みプルリクエストが、バージョン履歴内の更新としてスペースに同期されます。
docs をカスタマイズする
サイトナビゲーションを整理する
API リファレンス、ヘルプセンター、変更履歴など、サイトにはいつでもさらにコンテンツを追加できます。コンテンツを追加したら、ユーザーが必要な情報を簡単に見つけられるように、サイトのナビゲーションバーを整理できます。
詳しくは Concepts ページ サイトナビゲーションについてご覧ください。
詳しくは Site structure ページ サイトへのコンテンツ追加について詳しく知るには。
ドキュメントを公開する
docs を公開する
サイトはいつでもワンクリックで公開できます。
サイドバーでサイト名をクリックして、サイトのダッシュボードを開きます。次に 公開 を右上隅でクリックして公開します。
サイトが公開されると、ダッシュボードに公開中サイトへのリンクが表示されます。
公開についてさらに詳しく知りたいですか？ GitBook でコンテンツを作成して公開するための完全ガイド.
カスタムドメインを追加する
デフォルトでは、サイトは次の形式の一意の URL で公開されます。
https://[organization-name].gitbook.io/[site-title]これで十分なチームもありますが、多くのチームは URL を カスタムドメイン または カスタムサブディレクトリ.
に変更することを選びます。そのためには、サイドバーでサイト名をクリックしてサイトのダッシュボードを開き、次に 設定 タブを開いて、 ドメインとURL.
を選択します。画面上のボタンを使って希望するオプションを選び、手順に従ってドメインプロバイダーで DNS 設定を構成してください。
DNS の変更が反映されるまで最大 48 時間かかることがありますが、通常はそれよりずっと早く伝播します。
次のステップ
よくある質問
GitBook とは何ですか？
GitBook は、チームがブランド化された docs を Web サイトとして作成、レビュー、公開できる、コラボレーティブで AI ネイティブなドキュメントプラットフォームです。GitBook でホストされる docs サイトは、組み込みの AI Assistant を提供でき、MCP 経由で他の AI ツールにも接続できます。
高度なビジュアルエディタで Markdown を使ってコンテンツを編集したり、docs-as-code ワークフローのために docs を Git リポジトリと同期したり、あるいはその両方を組み合わせて使うこともできます。チームがどのように GitBook を使う場合でも、完全なバージョン履歴を備えた Git ライクなブランチワークフローを利用するため、チーム全体でのコラボレーションとフィードバックを促進しながら、メインのコンテンツを保護できます。
GitBook でドキュメントを公開するにはどうすればよいですか？
GitBook での公開は、コンテンツを公開できる状態になればシンプルなプロセスです。
新しい docs サイトを作成するか既存のものを開き、公開したいコンテンツを選びます。
サイトの対象読者を選びます。 公開 設定で全員に公開することも、 共有リンク または 認証アクセス.
で対象を制限することもできます。（任意）組み込みオプションを使って、ブランド、ドメイン、テーマをカスタマイズします。
右上の 公開これで完了です。docs が公開されました！後からさらにスペースをサイトセクションやバリアントとして追加できます。
詳しくは クイックスタートガイド をご覧いただくか、 GitBook でドキュメントを作成して公開するための完全ガイド.
GitBook はオープンソースですか？
GitBook 自体はオープンソースではありません。ただし、docs サイト上でドキュメントをホストして表示するために使われる GitBook の公開 docs プラットフォームはオープンソースです。 リポジトリを見る と、コードを確認し、変更をレビュー用に提出できます。
GitBook 自体はオープンソースではありませんが、 オープンソースプロジェクトは GitBook で無料でドキュメントを公開できます。チームは Community プラン に登録し、 Sponsored サイトプランを使ってコンテンツを公開できます。どちらも条件を満たすチームは無料です。
GitBook のサイトとスペースの違いは何ですか？
GitBook では、 docs サイト はドキュメント全体のハブであり、対象ユーザーがアクセスできるすべてのコンテンツをホストし、テーマやドメインなどのカスタマイズ可能なオプションを備えています。
各サイトには 1 つ以上の スペースが含まれます。これらはサイト内の個別セクションとして機能し、関連コンテンツを整理して、モジュール性と管理のしやすさを高めます。スペースを使うと特定のトピックにコラボレーションを集中でき、1 つのサイト上で複数のスペースを組み合わせて構造を作ったり、翻訳（ローカライズされたドキュメント向け）や複数製品対応のようなオプションを有効にしたりできます。
GitBook のビジュアルエディタと Git Sync の違いは何ですか？
GitBook では、ドキュメントを編集する主な方法が 2 つあります。ビジュアルエディタと Git Sync です。 ビジュアルエディタ は、高度なブロックベースのエディタで、Markdown サポートを含む従来型のユーザーインターフェースを使って GitBook 内で直接コンテンツを作成・変更できます。コードを直接扱わずに、より直感的で手を動かしやすい編集体験を好む人に最適です。
Git Sync は、ドキュメントのワークフローを Git リポジトリと統合し、「docs as code」アプローチを可能にします。このオプションは、慣れ親しんだ Git コマンドとワークフローを使って、コードベースと一緒にドキュメントを管理したい開発者やチームに最適です。
チームはこれらのワークフローのどちらか一方を選ぶことも、両方を組み合わせて使うこともできます。どの方法を選んでも、編集は完全なバージョン履歴とコンテンツレビューのプロセスを備えた、一貫した Git ライクなブランチワークフローに従います。これにより docs 全体でのコラボレーションと品質が向上するだけでなく、メインコンテンツを誤編集から保護できます。
最終更新
役に立ちましたか？