クイックスタート
GitBookで素早くセットアップして、数分で最初のドキュメントサイトを公開しましょう
このクイックスタートガイドでは、GitBook のセットアップ方法と、数分で最初のドキュメントサイトを公開する方法を説明します。
このガイドの最後まで進むと、公開中のドキュメントサイトができあがり、拡張やカスタマイズの準備が整います。
アカウントを作成
アカウントを作成する 最初のドキュメントサイトを始めましょう。
開始方法を選択する
GitBook へようこそ。新しいサイトで、どのように始めたいかを尋ねています。
Docs テンプレート
プレースホルダーのセクションが入った完成済みのドキュメントレイアウトから始める方法です。サイト全体が動作する様子を最短で確認できます。
インポート
オンラインのドキュメント、Markdown、または HTML から既存のコンテンツを取り込む場合。
OpenAPI
OpenAPI 仕様から、対話型の API リファレンスドキュメントを生成する場合。
空白
空のセクションから始めて、一から作成する場合。
Git と同期
GitHub または GitLab リポジトリと同期して、ドキュメントを最新の状態に保つ場合。
または、GitBook ですでに作業がある場合は、組織の既存コンテンツから選ぶこともできます。
このガイドではテンプレートの流れに沿って進めます：
クリック Docs テンプレート して、プレビューを確認します。
クリック Docs テンプレートを使用 して適用します。
新しいサイトを探索する
サイトは未公開の状態で開くため、公開前にすべてを編集、カスタマイズ、プレビューできます。サイドバーには次の内容が表示されます：
サイトヘッダー
サイト名、公開ステータス、そして プレビュー そして 公開 ボタンが表示されます。
一般
概要, 変更リクエスト, サイト構造、そして 設定.
ツール
スタイルガイド, カスタマイズ, 分析、そして 拡張.
コンテンツ
これらはサイトのセクションです。Docs テンプレートでは、Home、Documentation、API Reference、Changelog、Help Center です。上のアイコンを使って コンテンツ ヘッダーで使って、セクションの検索、名前変更、追加ができます。
コンテンツはまだ公開されていません。そのため、公開する前にドキュメントサイトを編集、カスタマイズ、プレビューできます。クリック 公開 してすぐに公開します。
コンテンツを編集する
Docs テンプレートでは、サイドバーの コンテンツ 部分にプレースホルダーのセクションが用意されています。任意のセクションをクリックして開き、プレースホルダーの内容を表示します。
GitBook では、コンテンツの編集と更新に 2 つの方法があります。ビジュアルエディタを使う方法と、docs-as-code のワークフローに従う方法です。 どちらか一方を選んでも、両方を組み合わせても構いません。 どのワークフローを選んでも、コンテンツは ブランチベースの編集フローを使って編集します。詳しくは コンセプトページ.
GitBook の WYSIWYG エディタでは、内容を視覚的に編集し、コンテンツブロックをドラッグして並べ替えたり、作業しながら見た目を確認したりできます。コードエディタを使いたくない場合や、Notion や Google Docs のようなツールに慣れている場合に最適です。
変更リクエストでドキュメントを編集する
その中で、 コンテンツ サイドバーのセクションで、Documentation などのセクションをクリックして開きます。
クリック 編集 右上隅で。これにより変更リクエストが開き、セクションの内容を変更できます。
クリック 新規追加… > ページ 左側の目次で。
新しいページにタイトルを付けます。
変更をプレビューする
Web アプリの上部には、次のタブがあります： エディタ, 変更、そして プレビュー。これらはコンテンツの異なる表示に切り替えます。クリック プレビュー して、変更リクエスト内のすべての変更を反映したドキュメントサイトが、デスクトップとモバイルの両方でどのように表示されるか確認します。
変更をマージする
変更に満足したら、右上隅の マージ ボタンをクリックします。これにより、変更リクエスト内のすべての編集でコンテンツのプライマリーバージョンが更新されます。コンテンツが公開中のドキュメントサイトの一部である場合、サイトはすぐに更新されます。
GitHub または GitLab リポジトリとドキュメントを同期して、既存の開発環境でコードベースの編集を有効にします。ほかのコードと並べてドキュメントを管理したい技術ユーザーに最適です。
Git Sync を設定する
同期したいセクションを コンテンツ サイドバーの部分から開きます。
Git Sync インジケーターの セットアップ ボタンをトップバーでクリックします。
指示に従って、選択した Git リポジトリにセクションを同期します。詳しくは Git Sync ページ をご覧ください。
開発環境からドキュメントを編集する
セクションを Git リポジトリに同期したら、次の手順に進みます：
リポジトリを開きます。
プルリクエストを作成します。
必要な変更を加えます。
GitBook は Markdown編集をサポートしているため、一般的な構文でコンテンツを作成・整形できます。
GitBook の標準ブロックはすべて、Markdown を使って記述・整形できます。
変更をプレビューする
できます 変更をプレビューする GitHub または GitLab のプルリクエストから、公開中のドキュメントサイトで。プルリクエストには、固有のプレビュー URL とともにステータスが表示されます。クリック 詳細 してそのステータスを開き、マージ後のサイトの見た目を確認します。
変更をマージする
プルリクエストをマージすると、コンテンツの更新は GitBook アプリ内でも、公開中ならドキュメントサイト上でも反映されます。GitBook アプリでは、すべてのコミットとマージされたプルリクエストが、バージョン履歴の更新としてセクションに同期されます。
ドキュメントを公開する
サイトはいつでもワンクリックで公開できます。
組織からサイトを開く ホーム.
クリック 公開 をサイトヘッダーで。
サイトが公開されると、 概要 画面が更新され、公開サイトへのリンクが表示されます。
公開についてさらに詳しく知りたいですか？ GitBook でコンテンツを作成し公開するための完全ガイド.
カスタムドメインを追加する
デフォルトでは、サイトは次の形式の一意の URL で公開されます：
https://[organization-name].gitbook.io/[site-title]これは一部のチームには適していますが、多くのチームは URL を カスタムドメイン または カスタムサブディレクトリ.
を拡張 設定 をサイトのサイドバーで。
クリック ドメインとURL.
希望するオプションを選択します。
ドメインプロバイダーで DNS 設定を構成するよう、指示に従ってください。
DNS の変更が反映されるまで最大 48 時間かかる場合がありますが、通常はもっと早く伝播します。
次のステップ
最終更新
役に立ちましたか？