GitBook UI

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

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

サイドバー

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

サイドバーを使うと、GitBook 組織の全体像をひと目で把握できます。サイドバーには次のものが含まれます:

• 組織の切り替え 複数の組織に参加している場合、ここでそれらを確認して切り替えできます。このメニューから新しい組織を作成することもできます。

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

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

• ホーム ホームページでは、チームが取り組んでいるすべての内容をひと目で確認できます。保留中の変更リクエスト、ディスカッションやコメント、最近のページ編集などを表示できます。

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

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

• Docs サイト このセクションを切り替えると、 docs サイト をサイドバー内でそのまま確認でき、クリックひとつで移動できます。

• スペース スペース セクションでは、 コレクション 、 スペース が見つかります。これは、コンテンツを追加するときに作成するものです。詳しくは、 コンテンツ構造 のセクションをご覧ください。

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

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

目次

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

既定では、目次には次の一覧が表示されます。 ページ、リンク、グループ これらはスペースを構成する要素です。サイドバーの右側に表示されます。現在表示しているスペースに固有のものです。

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

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

• 新しい ページ とサブページを作成

• ページグループを作成 外部リンクを作成

• 追加する 外部リンク

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

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

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

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

• ライブラリで新しい項目を作成またはインポートする

• ライブラリの項目をページへドラッグ＆ドロップする

• 任意のライブラリ項目はダブルクリックで名前を変更する

• 画像をプレビューする

• 画像とファイルを管理してダウンロードする

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

ページの内容にもっと集中したい場合は、カーソルを近くに合わせて表示される 非表示 ボタン をクリックすると、目次を一時的に隠せます。再び表示するには、ページの端の近くにカーソルを合わせて 表示 ボタン .

スペースヘッダー

スペースヘッダーはエディターの上部にあり、スペース全体に適用されるオプションを提供します。

スペースヘッダーには、現在表示しているスペースに関する情報が含まれます。スペースの公開や共有、スペースのコメントや履歴の表示、GitHub または GitLab の同期設定などができます。 GitHub または GitLab の同期などを使って、デフォルト設定をカスタマイズおよび上書きできます。

スペースヘッダーは柔軟に変化し、現在いるスペースやモードによって表示が変わります。

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

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

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

スペースヘッダーには次のものが含まれます:

• スペースの絵文字またはアイコン サイドバーで見分けやすくするために、スペース用の絵文字またはアイコンを選べます。

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

• スペースのパンくず スペースが含まれるコレクションまたは docs サイトの完全な階層リストです。

• アクションメニュー

  スペースに対するアクションの一覧を表示します。 ページアクションと同様に、利用できるスペースのアクションは現在のモードによって異なります。

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

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

• 変更表示 この表示では 変更がハイライト表示され、 差分表示を使って変更リクエスト内で行われた変更を確認できます。変更リクエストをマージして変更を本番反映する前に、新しいコンテンツをレビューするのに最適です。

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

• 共同編集者 現在あなたのスペース内のページを閲覧している他のユーザーのアバターです。色付きの円でカーソルの色を示します。アバターをクリックすると、そのユーザーが現在表示しているページに移動します。

• Git Sync の設定 この GitHub と GitLab の同期 をスペースに設定します。

• 共有メニュー スペースを公開して共有できます。また、このメニューから他の人を 共同作業 に招待することもできます。

• 変数 再利用可能な変数を作成して追加する スペース内で使用できます。

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

• コメント コンポーネントの props と コメントやディスカッション を使って、あなたやチームが行った内容についてやり取りできます。

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

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

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

サイトヘッダー

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

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

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

• サイトのパンくず メインの Docs サイト画面に戻るリンク。

• 概要 サイトの概要では、URL、公開ステータス、対象読者、コンテンツ、さらに上位レベルのインサイトなど、サイトに関する重要な情報を確認できます。

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

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

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

• プレビュー プレビュータブでは、公開したサイトがデスクトップとモバイルでライトモード・ダークモードの両方でどのように表示されるかをすばやく確認できます。

• 連携 このボタンを開くとモーダルが表示され、サイトに 連携 をインストールして設定できます。

• メンバーアクセス GitBook アプリで誰がサイトにアクセスできるか、またそれぞれにどんな権限があるかを表示・管理できます。

• サイトにアクセス これをクリックすると、公開済みの docs サイトが新しいタブで即座に開きます。このボタンはサイトが公開中の場合にのみ表示されます。

コンテンツエディター

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

エディターはスペースの中心部分であり、GitBook 内でコンテンツを書いたり挿入したりできます。マルチプレイヤーに対応しているため、あなたとチームはリアルタイムで変更を共同編集できます。

次のものを挿入できます コンテンツブロック、入力 Markdown, 埋め込みコンテンツし、変更について GitBook エージェント.

変更を作業するだけでなく、ブロックにコメントしたり、チームメイトにタグを付けたりすることもできます。

ページのタイトルと説明

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

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

次を選ぶことで、ページの URL スラッグを変更できます。 ページアクション > 名前を変更について詳しくは、以下をご覧ください。 ページアクション 以下

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

ページの アクションメニュー を使うと、ページの複製、名前変更、削除などができます。

次の方法で アクションメニュー を開くことができます。 サイドバーでページにカーソルを合わせたときに表示されるアイコン、またはページタイトルの横にあるアイコンを使います。

利用できるアクションの種類は、現在 ライブ編集 モードにいるか、 変更リクエスト.

ページオプション

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

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

次の方法で ページオプション サイドパネルは、ページの アクションメニュー を開いて オプションを選ぶか、ページのメインタイトルにカーソルを合わせて表示されたら ページオプション をクリックすることで開けます。

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

ページアウトライン

ページアウトラインには H1 と H2 の見出しが表示され、個々のページ内の特定のセクションへすばやく移動できます。

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

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

ページアウトラインは公開サイトにも表示されます。 ページオプション サイドパネル

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