For the complete documentation index, see llms.txt. This page is also available as Markdown.

用語集

1つの

アクションメニュー: GitBook のインターフェースでページやアイテムの横にある3つのドットをクリックすると開くメニューです。アクションメニューには、現在の表示モードに応じて異なるオプションが表示される場合があります。

新規追加: セクションの目次の下部にあるボタン/メニューで、セクションに新しいコンテンツを追加できます。以下を指す場合にも使われます。 + の横にあるボタンをクリック Docs サイト サイドバー内のヘッダーで、クリックすると新しいサイトを作成できます。

質問または検索: GitBook 内のコンテンツを検索するための検索ツールです。サイドバー上部をクリックして開くか、 ⌘ + Kを押します。標準検索のキーワードを入力したり、GitBook AI を使って質問したりできます。AI はコンテンツに基づいて結果を要約します。

対象読者設定: 公開された docs サイトにアクセスできるユーザーを決める設定です。 ドキュメントサイトを公開する のオプションについて詳しくは 対象読者設定メニュー.

B

ブロック: ページに追加するコンテンツはすべてブロック内に存在します。ブロックにはさまざまな種類があり、テキスト、画像、表、コード、API リファレンス、埋め込みコンテンツなどを追加できます。ブロックはドラッグして移動でき、設定を変更したり、場合によってはブロックの オプションメニュー.

C

変更リクエスト: 変更リクエストは GitHub のプルリクエストに似ています。同じセクションの複数のブランチを並行して作業でき、元のバージョンはそのまま保持されます。GitBook では新しい変更リクエストを作成してセクションを編集し、その変更をレビューに送信できます。誰かがその変更リクエストをマージするまで、その変更はメインのセクションには表示されません。

コンテキストメニュー: エディタでハイライトされたテキストの上に表示されるメニューです。太字、斜体、コードなど、さまざまな方法でテキストを整形したり、リンクや注釈をコピーに追加したりできます。

コメント: ページ上の任意のブロックにコメントを追加できるサイドパネルです。コメントに返信して ディスカッションを作成し、@ を使って人をタグ付けしたり、コメントに絵文字を追加したりできます。また、コメントに絵文字でリアクションしたり、不要になったコメントを解決済みにしたり、必要なコメントだけを表示するようにフィルタしたりもできます。

cover: ページの上部に表示される画像です。任意のページにカバーを追加でき、ページ全幅に広げることも、コンテンツの幅に合わせたヒーロー画像として使うこともできます。詳しくは ページ 詳細はこちらをご覧ください。

カスタムドメイン: docs サイト用に設定できるカスタマイズされた URL です。例: docs.yourcompany.com。これを 設定 パネルで設定できます。詳しくは カスタムドメインを設定する 詳細はこちらをご覧ください。

D

差分表示: 変更リクエスト内で追加、編集、削除されたページとブロックをハイライト表示する切り替えです。 変更を表示 のボタンを使ってオンにできます。 セクションヘッダー.

ディスカッション: コメントに返信するとディスカッションが作成されます。実質的には Comments サイドパネル内のスレッド形式の会話です。

docs サイト: GitBook エディタで書かれた情報を含む公開サイトです。docs サイトは GitBook アカウントを持たないユーザーでもアクセスできます。

ドメイン: docs サイトの URL のベース部分です。次の場所からカスタマイズできます ドメイン サイトの 設定 ページからも使用できます。 カスタムドメインの設定 を設定すると、この設定は上書きされます。

E

エディタ: アプリにログインすると表示される GitBook の UI です。GitBook のブロックベースのエディタは Markdown をサポートし、WYSIWYG 編集ツールを備えています。また、 blocks ページ上でブロックを追加・移動できます。

F

ファイル: 画像、動画、その他セクションにアップロードできるアイテムです。ファイルは ライブラリ タブで表示・管理できます。これは ページ の横、目次の上部にあります。

G

Git Sync: Git Sync GitHub または GitLab のリポジトリを GitBook と同期し、Markdown ファイルをドキュメントに変換できます。双方向同期なので、GitBook で行った変更はリポジトリに反映され、GitHub または GitLab で直接行った変更も GitBook に更新されます。Git Sync は、組織に GitHub Sync または GitLab sync のインテグレーションを追加することで設定できます。詳しくはこちら

GitBook AI: ナレッジベースとドキュメントで学習した AI アシスタントで、 質問に答えます。GitBook AI には、 質問するか検索 メニューからドキュメントに関するあらゆることを質問できます。また、GitBook AI に コンテンツの作成や編集を手伝ってもらうこともできます エディタ内で。

グループ: 関連するセクションの集合です。グループはセクション用のフォルダのようなものと考えるとよいでしょう。

I

インラインパレット: 種類 / ブロックの 中ほどで を エディタ でインラインパレットを開きます。画像や絵文字から Math & TeX まで、さまざまな種類のインラインコンテンツをブロックにすばやく追加できます。

挿入パレット: 種類 / が 空のブロック で挿入パレットを開きます。プラグインや再利用可能コンテンツを含む、作成できるすべてのブロックが表示されます。ブロックを検索して絞り込み、キーボードまたはカーソルで選択できます。

インサイト: GitBook に組み込まれた docs サイト向け分析ツールで、公開した docs サイトのページビュー、フィードバック、人気の検索語句を確認できます。

インテグレーション: GitBook のインテグレーションを使うと、GitBook のコンテンツを外部サービスやプラットフォームに接続できます。インテグレーションは、組織内の任意のセクションにインテグレーションメニューからインストールできます。

L

ライブ編集: 変更リクエストを作成せずに、ドキュメントのライブ版に変更を加えられる機能です。これは未公開の GitBook セクションのデフォルトオプションです。

ライブ編集のロック: ライブ編集をロックすると、GitBook のドキュメントに変更を加えるには変更リクエストを作成する必要があります。これにより、重要なドキュメントでのミスを防ぎ、適切な作業手順を維持できます。任意のセクションでライブ編集をロックでき、公開済みのセクションでは自動的に有効になります。

M

メンバー管理: 組織内のメンバーを表示・編集するためのツールで、管理者権限やアクセスできるコンテンツも含まれます。

O

オプションメニュー: ブロックの横にある6つのドットをクリックすると開くメニューです。ここでブロックの外観を変更できます。6つのドットをクリックしてドラッグすると、ブロックをページ上で移動できます。

P

ページ: ブロックを使ってコンテンツを追加または作成できる場所です。ページは セクションの中にあり、各ページにはタイトルと任意のアイコンまたは絵文字を付けられます。

ページグループ: ページをまとめる方法です。各ページグループには名前と任意のアイコンまたは絵文字を設定できます。

ページオプション: ページに対して ページオプション サイドパネルを使って選べるオプション群です。レイアウトのプリセットを選択したり、ページタイトルや説明、目次、ページのアウトラインを非表示にするなど、個別の設定を管理できます。詳しくは ページ.

R

再利用可能コンテンツ: セクション内の複数の場所で同期されるコンテンツです。作成すると 再利用可能なコンテンツ 必要なだけセクションに何度でも追加でき、そのすべてのインスタンスを同時に編集できます。セクションの再利用可能コンテンツは ライブラリ タブで表示・管理できます。これは ページ の 目次.

S

セクション: 関連するコンテンツを整理するための領域です。単一のページのほか、複数のページ、サブページ、ページグループを含めることができます。セクションは docs サイトに属し、公開された docs の上部にあるタブバーに表示され、ユーザーはコンテンツを切り替えられます。サイトの sections から サイト構造 サイトのサイドバーで。

セクションヘッダー: セクションを表示しているときに、セクション概要の下に表示されるメニューバーです。セクションのタイトルとアイコンに加え、コメント、壊れたリンク、変更リクエストを表示するボタンと、その 編集 ボタン。

セクション概要: セクションを表示しているときに GitBook アプリ上部に表示されるメニューバーです。現在のセクションのパンくずリストに加え、 Git Sync 設定ボタン、共有ボタン、そして アクションボタン が含まれます。他の人が同時にそのセクションで作業している場合は、ここにそのアバターも表示されます。

サイドバー: GitBook ウィンドウの左端にある領域です。そこには 質問するか検索 バー、docs サイトとコンテンツ、通知、インテグレーション、設定などが含まれます。

スラッグ: URL のカスタマイズ可能な末尾部分で、通常はドメインの後に / が付きます。docs サイトではサイトのタイトルから推測され、ドメインの後に続きます。必要に応じて、さらに ドメイン の サイト設定.

サブページ: 別のページの中にネストされたページで、通常は関連コンテンツを含みます。

T

目次: セクションを構成するドキュメントページ、リンク、ページグループの一覧です。ページの左側、サイドバーの隣にあります。目次(TOC)ではセクションの 再利用可能なコンテンツ と ファイルにもアクセスできます。TOC の右上付近にカーソルを置くと折りたためます。

V

バリアント:A バリアント はドキュメントの別バージョンです。たとえば、翻訳版の docs や、製品の別バージョン番号向けの docs などです。サイトの読者は公開サイト上のドロップダウンメニューを使って、異なるバリアント間を移動できます。

バージョン: 特定の時点でのセクションの保存済みスナップショットです。以前のセクションのバージョンには バージョン履歴 メニューからアクセスできます。

バージョン履歴: セクションに関する主なイベントを表示するメニューです。たとえば作成日、マージした変更リクエスト、誰かが以前のバージョンにロールバックした時点などが含まれます。任意のバージョンをクリックすると、その時点でセクションがどのように表示されていたかを確認でき、必要に応じて以前のバージョンにロールバックできます。

最終更新

役に立ちましたか?