クイックスタート
GitBookですぐに始めて、最初のドキュメントサイトを数分で公開しましょう
このクイックスタートガイドでは、GitBook でのセットアップ方法と、最初のドキュメントサイトを数分で公開する方法を説明します。
このガイドの最後には、公開中のドキュメントサイトができ上がり、拡張やカスタマイズの準備が整います。
始め方
必要なもの アカウントを作成する 必要があります。そうして初めて、最初のドキュメントサイトを使い始められます。
アカウントを作成すると、編集やカスタマイズの準備ができた新しいドキュメントサイトが自動的に表示されます。公開する前に、画面上のオプションからサイトにコンテンツを追加する方法を選択してください。
コンテンツはまだ公開されていません。公開する前に、ドキュメントサイトを編集、カスタマイズ、プレビューできます。 公開 を押すと、すぐに公開されます。
コンテンツを編集する
GitBook でコンテンツを編集・更新する方法は 2 つあります。ビジュアルエディターを使う方法と、docs-as-code ワークフローに従う方法です。 どちらか一方を選んでも、両方を組み合わせてもかまいません.
どのワークフローを選んでも、コンテンツは ブランチベースの編集フローを使って編集します。詳しくは 概念ページ.
ビジュアルエディターを使う
GitBook の WYSIWYG（見たままがそのまま反映される）エディターを使うと、コンテンツを視覚的に編集したり、コンテンツブロックをドラッグして並べ替えたり、作業しながら表示の見え方を確認できます。
このビジュアル編集ワークフローは、コードエディターを使いたくないユーザーや、Notion や Google Docs のようなツールを使った経験があるユーザーに最適です。
1. 変更リクエストでドキュメントを編集する
まず、サイドバーでドキュメントサイトを見つけ、その下にある項目をクリックします。すると、コンテンツが保存されているスペースに移動します。
クリック 編集 を右上でクリックします。すると変更リクエストが開き、スペースのコンテンツを編集できます。
クリック 新規追加… を左側の目次で選択してページを追加し、タイトルを付けます。
2. 変更内容をプレビューする
Web アプリの上部には、 エディター, 変更 と プレビューのタブがあります。これらでコンテンツの異なる表示に切り替えられます。
クリック プレビュー デスクトップとモバイルの両方で、変更リクエスト内のすべての変更が適用された状態のドキュメントサイトがどう表示されるかを、ライブプレビューで確認できます。
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 アプリでは、各コミットとマージ済みのプルリクエストが、バージョン履歴内の更新としてスペースに同期されます。
ドキュメントを公開する
ドキュメントを公開する
サイトはいつでもクリックひとつで公開できます。
サイドバーでサイト名をクリックしてサイトのダッシュボードを開きます。次に、 公開 を右上隅でクリックして公開します。
サイトが公開されると、ダッシュボードは公開サイトへのリンクを表示するように更新されます。
公開についてさらに詳しく知りたいですか？ GitBook でコンテンツを作成・公開するための完全ガイド.
カスタムドメインを追加する
デフォルトでは、サイトは次の形式の一意の URL で公開されます。
https://[organization-name].gitbook.io/[site-title]これは一部のチームには適していますが、多くのチームは URL を次のように変更することを選びます。 カスタムドメイン または カスタムサブディレクトリ.
これを行うには、サイドバーでサイト名をクリックしてサイトのダッシュボードを開き、次に 設定 タブを開いて ドメインと URL.
を選びます。画面上のボタンで希望のオプションを選択し、ドメインプロバイダーで DNS 設定を構成する手順に従ってください。
次のステップ
よくある質問
最終更新
役に立ちましたか？