sidebarGitBook UI

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

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

サイドバー

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

サイドバーを使うと、GitBook 組織の概要をひと目で確認できます。サイドバーには次のものがあります:

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

  • 通知 コメントや会話でタグ付けされたとき、または作業中のスペースで重要なアクティビティがあったときは、 通知 で新しい内容を表示します。

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

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

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

  • 連携 GitBook 連携機能arrow-up-right コンテンツを強化し、ページにさらに多くを埋め込んだり、他のアプリからナレッジベースに情報を追加したりできます。

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

  • スペース スペースセクションには コレクションスペース を見つけられます。コンテンツを追加するときに作成したものです。私たちの コンテンツ構造 セクションで詳細をご確認ください。

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

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

目次

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

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

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

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

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

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

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

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

  • ライブラリアイテムをページへドラッグ&ドロップする

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

  • 画像をプレビューする

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

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

ページのコンテンツにより集中したい場合は、カーソルを目次の横に置いて、表示される 非表示 ボタン The Hide button icon in GitBook をクリックして一時的に目次を隠せます。再び表示するには、カーソルをページの端の近くに置いて 表示 ボタン The Show button icon in GitBook.

スペースヘッダー

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

スペースヘッダーには、現在表示しているスペースに関する情報が含まれます。スペースの公開や共有、スペースのコメントや履歴の表示、設定などができます。 GitHub または GitLab の同期などが可能です。

circle-info

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

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

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

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

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

  • スペースの絵文字またはアイコン スペース用の絵文字またはアイコンを選択して、サイドバーで簡単に見分けられるようにできます。

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

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

  • アクションメニュー The Actions menu icon in GitBook

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

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

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

  • 変更表示 この表示では 変更内容が強調表示されます diff 表示を使って変更リクエスト内で行われた変更を確認できます。変更を本番反映するために変更リクエストをマージする前のレビューに最適です。

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

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

  • Git 同期の設定 次の GitHub と GitLab の同期 は、スペースの設定です。

  • 共有メニュー スペースを公開して共有できます。また、他のユーザーを 共同作業に招待するarrow-up-right こともできます。

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

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

  • コメント 次を表示できます: コメントとディスカッション あなたとチームがスペースのコンテンツについて行ったもの

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

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

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

サイトヘッダー

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

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

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

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

  • 概要 サイト概要では、URL、公開状況、対象ユーザー、コンテンツに加え、全体的なインサイトなど、サイトに関する重要な情報を確認できます。

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

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

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

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

  • 連携 このボタンを押すとモーダルが開き、インストールと設定ができます。 連携機能 あなたのサイト向けに

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

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

コンテンツエディタ

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

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

挿入できます コンテンツブロック、入力し、 Markdown, コンテンツを埋め込み、変更に共同作業できます GitBook Agent.

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

ページタイトルと説明

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

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

circle-info

ページの URL スラッグは、次を選択して変更できます: ページアクション The Actions menu icon in GitBook > 名前を変更。詳細はこちら: ページアクション 以下をご覧ください。

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

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

を開けます アクションメニュー 次を使って The Actions menu icon in GitBook サイドバーでページにカーソルを合わせたときに表示されるアイコン、またはページタイトル横のアイコンを使って。

circle-info

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

ページオプション

次の ページオプション サイドパネルには、ドキュメントとナビゲーションをカスタマイズするためのオプションがあります。

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

を開けます ページオプション サイドパネル。ページの アクションメニュー The Actions menu icon in GitBook を開いて オプションを選ぶか、ページのメインタイトルにカーソルを合わせて ページオプション が表示されたらクリックします。

circle-info

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

ページアウトライン

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

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

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

ページアウトラインは公開サイトにも表示されます。オン/オフを切り替えることもできます。 ページオプション サイドパネル。

circle-info

アプリの右側の列が表示されない場合は、ブラウザーのウィンドウ幅が 1430 ピクセル未満であることが原因かもしれません。ページアウトラインを表示して使用するには、ブラウザーのウィンドウ幅が少なくとも 1430 ピクセル必要です。

最終更新

役に立ちましたか?