クイックスタート

GitBookのWYSIWYG（見たまま編集）エディタでは、視覚的にコンテンツを編集し、コンテンツブロックをドラッグして並べ替え、作業中にコンテンツの見た目を確認できます。

このビジュアル編集ワークフローは、コードエディタで作業したくないユーザーや、NotionやGoogleドキュメントのようなツールに慣れているユーザーに最適です。

1. 変更リクエストでドキュメントを編集する

まず、サイドバーでドキュメントサイトを見つけ、その下の項目をクリックします。これにより、コンテンツが存在するスペースに移動します。

クリック 編集 右上にあります。これを開くと、スペースのコンテンツを編集できる変更リクエストが開きます。

クリック 新規追加… 左側の目次でページを追加し、タイトルを付けます。

2. 変更内容をプレビューする

Webアプリの上部には次のタブが表示されます エディタ, 変更 および 変更を強調表示します。。これらはコンテンツの異なる表示を切り替えます。

クリック 変更を強調表示します。 を選択すると、変更リクエスト内のすべての変更が反映されたドキュメントサイトがデスクトップとモバイルの両方でどのように見えるかをライブプレビューで確認できます。

3. 変更をマージする

変更に満足したら、右上の マージ ボタンをクリックします。

これにより、変更リクエストのすべての編集が主要コンテンツに反映されます。コンテンツがライブサイトの一部であれば、サイトはすぐに更新されます。

ドキュメントをGitHubまたはGitLabリポジトリと同期して、コードベースの編集を有効にします。同期すると、既存の開発環境でドキュメントを編集できます。

このワークフローは、ツールを切り替えずにドキュメントをコードと並行して管理したい技術ユーザーに最適です。

1. Git同期を設定する

サイト作成時にまだGit同期を設定していない場合は、まずサイドバーでドキュメントサイトを見つけ、その下のコンテンツ名をクリックしてください。これにより、コンテンツが存在するスペースに移動します。

をクリックします Git同期を設定する 右上のボタンをクリックして指示に従い、スペースを選択したGitリポジトリと同期してください。

に移動してください Git同期のページ で詳細を確認してください。

2. 開発環境からドキュメントを編集する

スペースをGitリポジトリと同期すると、そのリポジトリ内で開発環境からドキュメントの内容を更新できます。

リポジトリを開き、プルリクエストを作成して必要な変更を行います。

3. 変更をプレビューする

できます 変更をプレビューする GitHubまたはGitLabのプルリクエストから公開済みのドキュメントサイト上で行えます。

プルリクエストでは、ユニークなプレビューURLを含むステータスが表示されます。クリックすると、 詳細 そのステータスの上にある「詳細」をクリックしてプレビューURLを開き、プルリクエストがマージされサイトが更新されたときにどのように見えるか確認できます。

4. 変更をマージする

準備完了です。プルリクエストをマージすると、GitBookアプリとサイトの両方でコンテンツが更新されます（サイトがライブの場合）。

GitBookアプリでは、すべてのコミットとマージされたプルリクエストがバージョン履歴の更新としてスペースに同期されます。

APIリファレンス、ヘルプセンター、チェンジログなど、サイトにさらにコンテンツを追加できます。コンテンツを追加する際は、ユーザーが目的の情報を見つけやすくするためにサイトのナビゲーションバーを整理できます。

へ移動してください 概念ページ サイトナビゲーションの詳細については、

へ移動してください サイト構造のページ サイトへコンテンツを追加する方法の詳細については、

あなたのドキュメントサイトはデフォルトでも十分見栄えがしますが、公開サイトの外観や雰囲気を変更する多くの設定をカスタマイズすることもできます。

サイトの次をカスタマイズできます ロゴ、色、フォント、 サイトセクション および バリアントを追加したり、 サイトの可視性 設定など、さまざまな項目を更新できます。

サイトはいつでもクリック一つで公開できます。

サイドバーでサイト名をクリックしてサイトのダッシュボードを開きます。次に、 公開 右上のボタンをクリックして公開します。

サイトが公開されると、ダッシュボードにライブサイトへのリンクが表示されます。

デフォルトでは、サイトは次の形式のユニークなURLで公開されます：

https://[organization-name].gitbook.io/[site-title]

これが一部のチームにとっては適切な場合もありますが、多くのチームはURLを次のように変更することを選びます カスタムドメイン または カスタムサブディレクトリ.

これを行うには、サイドバーでサイト名をクリックしてサイトダッシュボードを開き、次に 設定 タブを開いて ドメインと URL.

を選択します。画面のボタンを使って希望のオプションを選び、ドメインプロバイダーでDNS設定を構成する手順に従ってください。