GitBook UI

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

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

サイドバー

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

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

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

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

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

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

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

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

• Docs サイト このセクションを切り替えると、すべての docs サイト をサイドバー内で直接表示し、クリックひとつで移動できます。

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

• 設定 サイドバーの下部に 個人設定 、 組織設定 があります。ここでは、ライト/ダークモードの切り替えや、必要に応じてサポートチームへの問い合わせもできます。

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

目次

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

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

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

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

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

• 作成 ページグループ

• 追加する 外部リンク

• アクセス アクションメニュー を個々のページで使用する。

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

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

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

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

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

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

• 画像をプレビューする

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

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

ページの内容をより重視したい場合は、カーソルをその横に置いて 非表示 ボタン をクリックすると、目次を一時的に隠せます。再表示するには、カーソルをページ端の近くに移動して 表示 ボタン .

スペースヘッダー

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

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

スペースヘッダーは柔軟に対応でき、現在いるスペースやモードに応じて変化します。

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

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

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

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

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

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

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

• アクションメニュー

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

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

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

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

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

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

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

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

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

• GitBook Agent スペース内の変更を、 GitBook Agent.

• コメント 詳しくは コメントとディスカッション を通じてチームと共同で行います。

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

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

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

サイトヘッダー

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

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

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

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

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

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

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

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

• プレビュー プレビュータブを使うと、公開済みサイトがデスクトップとモバイルで、ライトモードとダークモードそれぞれでどう表示されるかをすばやく確認できます。

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

• メンバーアクセス GitBook アプリ内で誰がサイトにアクセスできるか、またその権限が何かを確認・管理できます。

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

コンテンツエディタ

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

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

挿入できるものは コンテンツブロック、入力 Markdown, 埋め込みコンテンツ、そして GitBook Agent.

変更作業に加えて、ブロックへのコメント、チームメイトのタグ付けなどもできます。

ページタイトルと説明

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

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

ページの URL スラッグは、 ページ操作 > 名前を変更を選ぶことで変更できます。詳細は以下をご覧ください。 ページ操作 以下

ページ操作メニュー

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

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

利用できる操作の種類は、あなたが ライブ編集 モードにいるか、 変更リクエスト.

ページオプション

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

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

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

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

ページアウトライン

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

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

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

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

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