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