GitBook UI

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

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

サイドバー

GitBookのサイドバーには、ドキュメント全体のほか、通知、検索バー、スニペットなどが表示されます。

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

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

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

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

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

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

• 統合 GitBook 統合 はコンテンツを強化し、ページにより多くの要素を埋め込んだり、他のアプリからナレッジベースに情報を追加したりできるようにします。

• ドキュメントサイト このセクションを切り替えると、 ドキュメントサイト をサイドバーで一覧表示し、クリックで移動できます。

• スペース スペースのセクションには、あなたが追加コンテンツを作成する際に作成する コレクション および スペース が見つかります。詳細は、 コンテンツ構造 のセクションを参照してください。

• 設定 ここでは、 個人設定 および 組織設定 がサイドバーの下部にあります。ここでライト/ダークモードの切り替えを行ったり、必要に応じてサポートチームに助けを求めたりできます。

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

目次

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

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

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

目次の ページ タブから次のことができます:

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

• 作成 ページグループ

• 追加 外部リンク

• アクセス アクションメニュー を個別のページに対して利用できます。

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

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

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

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

• ライブラリのアイテムをページにドラッグアンドドロップする

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

• 画像のプレビュー

• 画像やファイルの管理とダウンロード

以下は目次、特にライブラリタブでできることを示す短い動画です:

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

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

スペースヘッダー

スペースヘッダーはエディタの上部にあり、スペース全体に適用されるオプションを提供します。 スペースヘッダーには、現在表示しているスペースに関する情報が含まれています。スペースを公開・共有したり、スペースのコメントや履歴を表示したり、などでデフォルト構成をカスタマイズおよび上書きできます。

GitHubまたはGitLabの同期を構成するなどの操作が行えます。

スペースヘッダーは適応型であり、 変更リクエスト現在のスペースやモードに応じて変化します。

たとえば、もしあなたが

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

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

• 変更リクエスト内のスペースヘッダー。 スペースヘッダーには次のものが含まれます:

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

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

• 操作メニュー

  スペースのパンくずリスト スペースが属するコレクションやドキュメントサイトの完全な線形リスト。スペースに対するアクションの一覧を提供します。

• 概要 ページアクション

• に似て、スペースで利用できるアクションは現在のモードによって異なります。 変更リクエストを表示しているとき、このタブは変更リクエストのタイトルと説明、参加者とレビュアーを表示します。また、すべての変更とコメントも表示します。

• エディタビュー このビューでは、GitBookのブロックベースエディタを使ってコンテンツを編集できます。 変更ビュー このビューは、差分表示を用いて変更リクエスト内で行われた

• 変更を強調表示します。 新しいコンテンツをマージして変更を公開する前に確認するのに最適です。

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

• 共同編集者 この あなたのスペース内で現在ページを閲覧している他の誰かのアバターで、カーソルの色を示すカラフルな丸が表示されます。アバターをクリックすると、その人が現在見ているページにジャンプします。 Git同期の構成

• GitHubおよびGitLabの同期 をスペース用に構成します。 共有メニュー スペースを公開・共有することができます。また、このメニューから他の人を

• コラボレーションに招待 することもできます。 変数

• GitBook エージェント 再利用可能な変数を作成してスペースで使用できるように追加します。 GitBook エージェント.

• 共同でスペース内の変更に取り組むには、 詳細は コメント スペースのコンテンツについてあなたやチームが交わしたコメントや議論です。

• 変更リクエスト 作成、更新、削除 変更リクエスト をスペース内で行います。

• スペース履歴 表示 バージョン履歴 スペースで行われたすべての変更、または現在の変更リクエストでの変更を時間を遡って確認できます。

• 編集ボタン スペースが公開されているか、誰かが ライブ編集をロックしている場合、 編集 ボタンはスペースヘッダーに表示されます。それを押すと新しい 変更リクエスト が作成されてコンテンツを編集できます。

サイトヘッダー

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

サイトヘッダーには次のものが含まれます:

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

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

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

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

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

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

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

• 統合 このボタンはモーダルを開き、サイトに 統合 をインストールおよび構成

• できるようにします。 メンバーアクセス

• GitBookアプリで誰があなたのサイトにアクセスできるか、またどの権限を持っているかを表示および管理します。 サイトを表示

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

コンテンツエディタ

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

エディタはスペースの主要部分で、GitBookでコンテンツを書いたり挿入したりする場所です。マルチプレイヤーをサポートしており、チームとリアルタイムで共同編集できます。 次のものを挿入できます:コンテンツブロック Markdown, 埋め込みコンテンツを入力したり、 GitBook エージェント.

と共同で変更に取り組むことができます。

さらに、ブロックにコメントしたり、チームメンバーをタグ付けしたりすることも可能です。

ページタイトルと説明 各ページの上部で、タイトル を設定し、オプションで絵文字 を追加し、説明

を書くことができます。使用したタイトルは目次に表示され、公開時にページのURLスラッグの元になります。

ページの説明は最大200文字で、検索エンジンでのページのプレビュー文として機能します。 ページのURLスラッグは、 > ページアクションを選択して変更できます。 ページのURLスラッグは、 詳細については、以下を参照してください。

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

ページの 操作メニュー により、ページの複製、名前変更、削除などを行うことができます。

を開くには、 操作メニュー サイドバーでページにカーソルを合わせたときに表示される アイコン、またはページタイトルの横にあるアイコンを使用します。

利用可能なアクションの種類は、あなたが ライブ編集 モードにいるか、 変更リクエスト.

かによって異なります。

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

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

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

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

ページアウトライン

ページアウトラインはH1およびH2見出しを表示し、個々のページ内の特定のセクションへ素早く移動できます。

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

あなたがページに追加した任意の 見出し はここに一覧表示されるページアウトラインに表示されます。

ページアウトラインは公開サイトにも表示されます。 かによって異なります。 サイドパネルからそれを選択することで、スペースのどこからでも参照できます。

でオン/オフを切り替えることができます。もしアプリの右側のカラムが見えない場合、ブラウザウィンドウの幅が1430ピクセル未満である可能性があります。ページアウトラインを表示および使用するには、ブラウザウィンドウの幅が少なくとも1430ピクセル必要です。