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

用語集

1つの

アクションメニュー: GitBookの画面で、ページやアイテムの横にある3点リーダーをクリックすると開くメニューです。Actionsメニューに表示される項目は、現在の表示モードによって異なる場合があります。

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

質問または検索: GitBook内のコンテンツを検索するツールです。サイドバー上部をクリックして開くか、次を押します ⌘ + K

アクセス対象設定: 公開済みのドキュメントサイトにアクセスできる人を決定する設定です。参照 ドキュメントサイトを公開する 次のオプションの詳細については アクセス対象設定メニュー.

B

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

C

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

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

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

カバー: ページ上部に表示される画像です。任意のページにカバーを追加でき、ページ全体の幅に広げることも、ヒーロー画像としてコンテンツ幅のみに設定することもできます。参照 ページ で詳細を確認してください。

カスタムドメイン: ドキュメントサイトに設定できるカスタマイズされたURLです。例: docs.yourcompany.com。次の場所で設定できます 設定 ドキュメントサイトのパネル。参照 カスタムドメインを設定する で詳細を確認してください。

D

差分ビュー: 変更リクエスト内で、どのページやブロックが追加・編集・削除されたかを強調表示する切り替えです。次を使ってオンにできます 変更を表示セクションヘッダー.

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

ドキュメントサイト: GitBookエディタで作成した情報を含む公開サイトです。ドキュメントサイトは、GitBookアカウントを持たないユーザーでもアクセスできます。

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

E

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

F

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

G

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

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

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

I

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

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

インサイト: 公開済みのドキュメントサイトでページビュー、フィードバック、人気の検索を確認できる、GitBookの組み込み分析ツールです。

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

L

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

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

M

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

O

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

P

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

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

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

R

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

S

セクション: 関連コンテンツを整理できる領域です。1ページだけの場合も、複数ページ、サブページ、ページグループを含む場合もあります。セクションはドキュメントサイトに属し、公開済みドキュメントの上部のタブバーに表示されるため、ユーザーはコンテンツを切り替えられます。サイトの セクション から サイト構造全般 サイトのサイドバーから。

セクションヘッダー: セクションを表示すると、セクション概要の下にあるメニューバーです。セクションのタイトルとアイコンのほか、コメント、壊れたリンク、変更リクエストを表示するボタン、さらに次のものが含まれます 編集 ボタン。

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

サイドバー: GitBookウィンドウの最も左側の領域です。次のものが含まれます 質問または検索 バー、ドキュメントサイトとコンテンツ、さらに通知、連携、設定などが含まれます。

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

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

T

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

V

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

バージョン: 特定の時点で保存されたセクションのスナップショットです。セクションの以前のバージョンには次の場所からアクセスできます バージョン履歴 メニューを開きます。

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

最終更新

役に立ちましたか?