GitBook UI

GitBookのエディタにあるさまざまなコンポーネントとUIについて学ぶ

GitBook は、作成したコンテンツを整理・管理しやすくするために、複数のセクションに分かれています。

サイドバー

GitBook のサイドバーには、ドキュメントに加えて通知、検索バー、スニペットなどがすべて含まれます。

サイドバーでは、GitBook 組織の概要を一目で確認できます。サイドバーには以下が含まれます：

• 組織切替 複数の組織に所属している場合、ここでそれらを表示・切り替えることができます。また、このメニューから新しい組織を作成することもできます。

• 通知 コメントや会話でタグ付けされたとき、または作業中のスペースで重要なアクティビティがあったときに、 通知 で新着情報を知らせます。

• 質問または検索 提供： GitBook AI、自然言語で質問したり、組織内のさまざまなスペースやコンテンツを検索したりできます。

• ホーム ホームページでは、チームが取り組んでいる内容を一目で確認できます。オープンな変更リクエスト、議論やコメント、最近のページ編集などを表示できます。

• ドキュメントサイト ホーム これをクリックすると、組織内で作成したすべてのドキュメントサイトの概要ページに移動します。

• 連携（Integrations） GitBook 連携 はコンテンツを強化し、ページにより多くの埋め込みを追加したり、他のアプリからナレッジベースに情報を追加したりできるようにします。

• ドキュメントサイト このセクションを切り替えて、組織内のすべての ドキュメントサイト をサイドバー内で表示し、クリックでそのサイトにジャンプできます。

• スペース スペースセクションでは、以下の コレクション や スペース を見つけることができます。より詳しくは、 コンテンツ構造 セクションをご覧ください。

• 設定 サイドバーの下部には、 個人設定 や 組織設定 が表示されます。ここではライト/ダークモードの切り替えや、必要に応じてサポートチームへのヘルプ依頼もできます。

• ゴミ箱 削除されたスペースはゴミ箱に表示されます。最大7日間は復元できますが、その後は完全に削除されます。

目次

目次には、選択したスペース内のすべてのページとリンクが一覧表示されます。

デフォルトでは、目次はスペースを構成する ページ、リンク、グループ のリストを表示します。目次はサイドバーの右側にあり、現在表示しているスペースに固有のものです。

目次は、スペース用の 再利用可能なコンテンツ や ファイル を表示・管理できる場所でもあります。

目次の ページ タブからは以下ができます：

• 新規作成 ページ およびサブページ

• 作成 ページグループ

• 追加 外部リンク

• アクセス 個別ページのアクションメニュー に。

「 ライブラリ 」タブでは、次のことができます：

• スペース内の再利用可能なコンテンツ、変数、画像、ファイルを表示および検索する

• 他のスペースから再利用可能なコンテンツを表示して挿入する

• ライブラリに新しいアイテムを作成またはインポートする

• ライブラリのアイテムをドラッグ＆ドロップでページに置く

• ライブラリのアイテムをダブルクリックして名前を変更する

• 画像のプレビュー

• 画像やファイルを管理およびダウンロードする

以下は、目次、特にライブラリタブで何ができるかを示す短いビデオです：

ページのコンテンツにより集中したい場合は、目次の横にカーソルを合わせて表示される 非表示 ボタン をクリックして目次を一時的に隠すことができます。再表示するには、ページの端近くにカーソルを合わせて 表示 ボタン .

をクリックしてください。

スペースヘッダー

スペースヘッダーはエディタの上部にあり、スペース全体に適用されるオプションを提供します。 スペースヘッダーには、現在表示中のスペースに関する情報が含まれています。スペースを公開・共有したり、スペースのコメントや履歴を表示したり、GitHub または GitLab 同期

の設定などが行えます。スペースヘッダーは適応型です

で、現在のスペースやモードに応じて変化します。 たとえば、変更リクエスト

を編集している場合、変更リクエストの概要とともに、エディタを開く、変更を表示する、変更リクエストをマージするなどのオプションが表示されます。

読み取り専用のスペースを表示している場合、ライブ編集がロックされているため、コンテンツを編集するには新しい変更リクエストを作成する必要があります。

変更リクエスト内のスペースヘッダー。

• スペースヘッダーには以下が含まれます： スペースの絵文字またはアイコン

• サイドバーでスペースを簡単に識別できるように、スペース用の絵文字やアイコンを選択できます。 スペース名

• サイドバーに表示されるスペースの名前で、公開する場合はドキュメントにも表示されます。 スペースのパンくずリスト

• スペースが属するコレクションやドキュメントサイトの完全な線形リストです。

  アクションメニュー スペースに対するアクションの一覧を提供します。ページアクションと同様に、スペースで利用できるアクションは現在のモードによって異なります。（重複）

• 概要 変更リクエストを表示しているとき、このタブは変更リクエストのタイトルと説明、参加者とレビュアーを表示します。また、すべての変更とコメントも表示します。

• エディタビュー このビューでは、GitBook のブロックベースエディタを使用してコンテンツを編集できます。

• 差分ビュー このビューは、 変更点を強調表示 して、変更リクエスト内で行われた変更を差分表示します。変更リクエストをマージして変更を反映する前に新しいコンテンツをレビューするのに最適です。

• プレビュー このビューでは、変更リクエストをマージする前にコンテンツのプレビューをすばやく確認できます。

• 共同編集者 スペース内のページを現在閲覧している他のユーザーのアバターが表示され、カーソルカラーを示す色付きサークルが付与されます。アバターをクリックすると、そのユーザーが現在見ているページにジャンプします。

• Git 同期の設定 スペースの GitHub および GitLab 同期 の設定です。

• 共有メニュー スペースを公開・共有することができます。このメニューから他の人を 共同編集者として招待 することもできます。

• 変数 スペースで使用する再利用可能な変数を作成・追加します。 をスペースで使用するために作成・追加します。

• GitBook エージェント スペース内の変更について GitBook エージェント.

• で共同作業する コメント スペースのコンテンツについて、チームと交わした コメントや議論

• を確認できます。 変更リクエスト スペース内で 変更リクエスト

• を作成、更新、削除できます。 スペース履歴 を表示する スペース内で行われたすべての変更、または現在の変更リクエストでの変更を含むバージョン履歴を確認できます。

• 編集ボタン スペースが公開されているか、誰かが ライブ編集をロックしている場合、 編集 ボタンがスペースヘッダーに表示されます。これによりコンテンツを編集するための新しい たとえば、 が作成されます。

サイトヘッダー

サイトヘッダーには、現在表示しているサイトに関する情報が含まれています。サイトのインサイトを表示したり、サイトをカスタマイズしたり、設定を変更したり、さまざまなモードや画面サイズでサイトをプレビューしたりできます。連携の設定やメンバーのアクセス管理も行えます。

サイトヘッダーには以下が含まれます：

• サイト名 スペース名

• サイトのパンくずリスト ドキュメントサイトのメイン画面に戻るリンク。

• 概要 サイトの概要では、URL、公開状態、対象読者、コンテンツ、ならびにトップレベルのインサイトなど、サイトに関する重要な情報が表示されます。

• インサイト スペースの インサイトパネル は、サイトとそのパフォーマンスに関する詳細な分析を提供します。

• カスタマイズ ここでは、 サイトをカスタマイズ して、独自のロゴ、カラー、ヘッダーリンクなどを設定できます。

• 設定 サイトの 設定にアクセス して、名前、対象読者、コンテンツ構造やその他のオプションを管理できます。

• プレビュー プレビュータブでは、公開されたサイトがデスクトップおよびモバイル表示でライト/ダークモードそれぞれどのように見えるかを素早く確認できます。

• 連携（Integrations） このボタンはモーダルを開き、サイト用の 連携 をインストールおよび設定できるようにします。

• メンバーアクセス GitBook アプリでサイトにアクセスできるユーザーと、その権限を表示・管理します。

• サイトを表示 これをクリックすると、公開されたドキュメントサイトが新しいタブで即座に開きます。このボタンはサイトが公開されている場合にのみ表示されます。

コンテンツエディタ

GitBook のエディタでコンテンツを書き、ブロックを追加します。

エディタはスペースの主要部分で、GitBook 上でコンテンツを作成・挿入できます。マルチプレイヤーをサポートしており、チームとリアルタイムで共同編集が可能です。

以下を挿入できます： コンテンツブロック、タイプ Markdown, コンテンツを埋め込む、およびで共同作業する GitBook エージェント.

変更の作業に加えて、ブロックにコメントを付けたり、チームメンバーをタグ付けしたりできます。

ページタイトルと説明

各ページの上部では、 タイトルを設定し、任意で 絵文字を追加し、 説明を書くことができます。使用したタイトルは目次に表示され、公開時にはページの URL スラッグを形成します。

ページの説明は最大200文字までで、検索エンジンでのページのプレビュー文として機能します。

ページの URL スラッグは、 ページアクション > の名前変更 ページアクション を選択して変更できます。詳細は以下を参照してください。

ページアクションメニュー

ページの スペースが属するコレクションやドキュメントサイトの完全な線形リストです。 では、ページを複製、名前変更、削除するなどの操作ができます。

を開くには、サイドバーでページにカーソルを合わせたときに表示される スペースが属するコレクションやドキュメントサイトの完全な線形リストです。 アイコンを使用するか、ページタイトルの横のアイコンから開きます。 利用できるアクションの種類は、

ライブ編集 モードか、または ページオプション たとえば、.

かによって異なります。

スペースの かによって異なります。 サイドパネルは、ドキュメントやナビゲーションのカスタマイズオプションを提供します。

ページオプションを使うと、ドキュメントのレイアウトやナビゲーションをカスタマイズできます。ページオプションは編集モードのときにのみアクセス可能です。

を開くには、サイドバーでページにカーソルを合わせたときに表示される かによって異なります。 サイドパネルは、ページの アクションメニュー を開いて オプションを選択するか、ページのメインタイトルにカーソルを合わせて表示される かによって異なります。 をクリックすることで開けます。

目次を無効にするなどの一部の変更は、公開されたドキュメントにのみ適用され、エディタ内では表示されない場合があります。

ページ概要（アウトライン）

ページ概要は H1 と H2 見出しを表示し、個々のページ内の特定のセクションにすばやくジャンプできます。

スペースの ページアウトライン はエディタの右側にあり、探しているページのセクションに直接移動しやすくします。

任意の 見出し をページに追加すると、ここに一覧表示されます。

ページアウトラインは公開サイトにも表示されます。サイドパネルでオン/オフを切り替えることができます。 かによって異なります。 サイドのカラムが表示されない場合は、ブラウザのウィンドウ幅が1430ピクセル未満である可能性があります。ページアウトラインを表示・使用するには、ブラウザウィンドウの幅が少なくとも1430ピクセル必要です。

アプリの右側の列が見えない場合、ブラウザウィンドウの幅が1430ピクセル未満である可能性があります。ページアウトラインを表示・使用するには、ブラウザウィンドウの幅が少なくとも1430ピクセル必要です。