クイックスタート
GitBookをすぐに使い始めて、数分で最初のドキュメントサイトを公開しましょう
このクイックスタートガイドでは、GitBookでのセットアップ方法と、数分で最初のドキュメントサイトを公開する方法を説明します。
このガイドの最後には、公開済みのドキュメントサイトができ、拡張やカスタマイズの準備が整います。
アカウントを作成
アカウントを作成する 最初のドキュメントサイトを始めるには。
開始方法を選択してください
GitBookへようこそ。新しいサイトで、どのように始めるかを尋ねます。
ドキュメントテンプレート
プレースホルダーセクションを含む完成済みのドキュメントレイアウトから始める方法で、完全なサイトが動作する様子を最も早く確認できます。
インポート
オンラインドキュメント、Markdown、またはHTMLから既存のコンテンツを取り込みます。
OpenAPI
OpenAPI仕様から対話型のAPIリファレンスドキュメントを生成します。
空白
空のセクションから始め、ゼロから構築します。
Gitと同期
GitHubまたはGitLabリポジトリとドキュメントを同期させます。
あるいは、GitBookですでに作業しているものがあれば、組織の既存コンテンツから選ぶこともできます。
このガイドではテンプレートの流れに従います:
クリック ドキュメントテンプレート とプレビューを確認します。
クリック ドキュメントテンプレートを使用 を適用します。
新しいサイトを探索する
サイトは未公開の状態で開くため、公開前にすべてを編集、カスタマイズ、プレビューできます。サイドバーには次が表示されます:
サイトヘッダー
サイト名、公開ステータス、および プレビュー および 公開 ボタン。
全般
概要, 変更リクエスト, サイト構造、および 設定.
ツール
スタイルガイド, カスタマイズ, 分析、および 拡張.
コンテンツ
これらはサイトのセクションです。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時間かかる場合がありますが、通常はもっと早く伝播します。
次のステップ
最終更新
役に立ちましたか？