用語集
1つ目は
アクションメニュー: GitBook インターフェースで、ページやアイテムの横にある3つのドットをクリックすると開くメニューです。アクションメニューには、現在の表示モードに応じて異なるオプションが表示される場合があります。
新規追加: スペースの目次の下部にあるボタン/メニューで、スペースに新しいコンテンツを追加できます。また、次のものを指す場合にも使われます。 + 横のボタン Docs サイト 、 スペース サイドバーのセクション見出し。クリックすると、新しいサイト、スペース、またはコレクションを作成できます。
質問するか検索: GitBook 内のコンテンツを検索するための検索ツールです。サイドバー上部をクリックして開くか、 ⌘ + Kを押します。標準検索のキーワードを入力することも、GitBook AI を使って質問することもできます。AI はコンテンツに基づいて結果を要約します。
オーディエンス設定: 公開されたドキュメントサイトへのアクセスを許可するユーザーを決定する設定です。詳細は ドキュメントサイトを公開する を参照してください。以下のオプションについては オーディエンス設定メニュー.
B
ブロック: ページに追加するすべてのコンテンツはブロックとして存在します。ブロックにはさまざまな種類があり、テキスト、画像、表、コード、API リファレンス、埋め込みコンテンツなどを追加できます。ブロックはドラッグして移動でき、設定を変更したり、場合によっては別の種類のブロックに変更したりできます。これはブロックの オプションメニュー.
C
変更リクエスト: 変更リクエストは GitHub のプルリクエストに似ています。同じスペースの複数のブランチを並行して作業しながら、元のバージョンをそのまま維持できます。GitBook では、新しい変更リクエストを作成してスペースに編集を加え、その変更をレビューに送信できます。誰かがその変更リクエストをマージするまで、変更はメインのスペースには表示されません。
コレクション: スペースのグループです。コレクションは、スペース用のフォルダのようなものだと考えることができます。
コンテキストメニュー: エディターでハイライトされたテキストの上に表示されるメニューです。太字、斜体、コードなど、さまざまな方法でテキストを整形したり、リンクや注釈を追加したりできます。
コメント: ページ上の任意のブロックにコメントを追加できるサイドパネルです。コメントに返信して ディスカッションを作成したり、@ を使って人をタグ付けしたり、コメントに絵文字を追加したりできます。また、絵文字でリアクションしたり、不要になったコメントを解決済みにしたり、必要なコメントだけを絞り込んで表示したりできます。
カバー: ページの上部に表示される画像です。任意のページにカバーを追加でき、ページ全幅に表示することも、ヒーロー画像としてコンテンツ幅のみに表示することもできます。参照: ページ で詳細を確認できます。
カスタムドメイン: docs.yourcompany.com のように、ドキュメントサイト用に設定できるカスタマイズされた URL です。設定はドキュメントサイトの 設定 パネルで行えます。参照: カスタムドメインを設定する で詳細を確認できます。
D
差分表示: 変更リクエスト内で、どのページとブロックが追加、編集、削除されたかをハイライト表示する切り替え機能です。 変更を表示 ボタンを スペースヘッダー.
ディスカッション: コメントに返信するとディスカッションが作成されます。実質的には、コメントのサイドパネル内のスレッド形式の会話です。
ドキュメントサイト: GitBook エディターで書かれた情報を含む公開サイトです。ドキュメントサイトは、GitBook アカウントを持たないユーザーでもアクセスできます。
ドメイン: ドキュメントサイトの URL のベース部分です。これは ドメイン セクションからカスタマイズできます。 設定 ページ。 カスタムドメインの設定 を行うと、この設定は上書きされます。
E
エディター: アプリにログインしたときに表示される GitBook の UI です。GitBook のブロックベースのエディターは、Markdown のサポートと WYSIWYG 編集ツールを備えており、ページ上に ブロック を追加したり移動したりできます。
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 に組み込まれた、ドキュメントサイト向けの分析ツールです。公開されたスペースのページビュー、フィードバック、人気の検索を確認できます。
連携: GitBook の連携機能を使うと、GitBook のスペースをサードパーティのサービスやプラットフォームに接続できます。組織内の任意のスペースに対して、Integrations メニューから連携をインストールできます。
L
ライブ編集: 変更リクエストを作成せずに、ドキュメントのライブ版に変更を加えられる機能です。これは未公開の GitBook スペースの既定のオプションです。
ライブ編集のロック: ライブ編集をロックすると、GitBook 内のドキュメントを変更するには変更リクエストの作成が必要になります。これにより、重要なドキュメントでのミスを防ぎ、適切な作業手順を維持しやすくなります。任意のスペースでライブ編集をロックでき、公開済みスペースでは自動的に有効になります。
M
メンバー管理: 管理者権限やアクセス可能なスペースを含め、組織内のメンバーを表示・編集できるツールです。
O
オプションメニュー: ブロックの横にある6つのドットをクリックすると開くメニューです。ここでブロックの見た目を変更できます。6つのドットをクリックしてドラッグすると、ブロックをページ内で移動できます。
P
ページ: ブロックを使ってコンテンツを追加または作成できる場所です。ページは スペースの中にあり、各ページにはタイトルと、任意でアイコンや絵文字を付けられます。
ページグループ: ページをまとめるための方法です。各ページグループには名前と、任意のアイコンまたは絵文字を設定できます。
ページオプション: ページに対して ページオプション サイドパネルを使って設定できるオプションの مجموعهです。レイアウトのプリセットを選択したり、ページタイトルや説明、目次、ページアウトラインを非表示にするなど、個別のオプションを制御できます。詳細は ページ.
R
再利用可能なコンテンツ: スペース内の複数の場所で同期されるコンテンツです。 再利用可能なコンテンツ を作成すると、必要な回数だけスペースに追加でき、そのすべてのインスタンスを同時に編集できます。スペースの再利用可能なコンテンツは 再利用可能なコンテンツ タブから確認・管理できます 目次.
S
サイドバー: GitBook ウィンドウの最も左側にある領域です。ここには 質問するか検索 バー、すべてのドキュメントサイト、スペース、コレクションのほか、通知、連携、設定などが含まれます。
サイトセクション: ドキュメントサイトをコンテンツハブのように使いたい場合、複数のスペースを同じドキュメントサイトに サイトセクションとして公開できます。これらのサイトセクションは、公開されたドキュメントの上部にあるタブバーに表示され、ユーザーはコンテンツを切り替えられます。サイトセクションは 構造 のセクションで設定できます サイト設定.
スラッグ: URL の末尾をカスタマイズできる部分で、通常はドメインの後ろに / が続きます。ドキュメントサイトでは、これはサイトのタイトルから推測され、ドメインの後に続きます。必要に応じて、さらに ドメイン のセクションで設定できます サイト設定.
スペース: 関連するコンテンツを整理できる領域です。単一のページ、または複数のページ、サブページ、ページグループを含めることができます。
スペースヘッダー: スペースを表示しているとき、スペース概要の下にあるメニューバーです。スペースのタイトルとアイコンのほか、コメント、壊れたリンク、変更リクエストを表示するボタン、および 変更リクエストで編集 ボタンをクリックしてください。
スペース概要: スペースを表示しているときに GitBook アプリ上部に表示されるメニューバーです。現在いるスペースのパンくずリストのほか、 Git Sync 設定ボタン、共有ボタン、そして アクションボタン が含まれます。同じスペースで他の人も作業している場合は、ここにそのアバターも表示されます。
サブページ: 別のページの下にネストされたページで、通常は関連するコンテンツを含みます。
T
目次: スペースを構成するドキュメントページ、リンク、グループの一覧です。ページの左側、サイドバーの隣にあります。目次(TOC)からはスペースの 再利用可能なコンテンツ 、 ファイルにもアクセスできます。目次の右上付近にカーソルを合わせると折りたためます。
V
バリアント: A バリアント はドキュメントの別バージョンです。たとえば、翻訳版のドキュメントや、製品の別バージョン向けのドキュメントなどです。サイトの閲覧者は、公開サイト上のドロップダウンメニューを使って、さまざまなバリアントを切り替えられます。
バージョン: 特定の時点におけるスペースの保存されたスナップショットです。スペースの過去のバージョンには バージョン履歴 メニューを開きます。
バージョン履歴: スペースの主要なイベントを表示するメニューです。たとえば作成日、マージした変更リクエスト、誰かが以前のバージョンにロールバックした時点などが表示されます。任意のバージョンをクリックすると、その時点でスペースがどのように見えていたかを確認でき、必要に応じて以前のバージョンにロールバックできます。
最終更新
役に立ちましたか?