再利用可能なコンテンツ

スペース全体で使用でき、インスタンスを変更するとすべて同時に更新される再利用可能なコンテンツブロックを作成します

この機能は～で利用できます ProプランおよびEnterpriseプラン.

再利用可能なコンテンツを使うと、複数のページやスペース間でコンテンツを同期できるため、ブロックのすべてのインスタンスを同時に編集できます。

スペース内で再利用可能なコンテンツを作成します。

基本

再利用可能なコンテンツは他のコンテンツとまったく同じように機能します。変更リクエストを通じて修正でき、レビュー ワークフローに含めることもでき、公開済みのどのサイトでも正しく表示されます。

再利用可能なコンテンツは複数のスペースから参照できますが、属するのは1つの 親スペース.

「親スペース」の概念

親スペースとは、再利用可能なコンテンツを所有するスペースのことです。そのコンテンツを編集できるのはそこだけです。

再利用可能なコンテンツの更新はすべてのインスタンスに即座に反映されますが、変更はすべて親スペースから開始する必要があります。直接編集するか、変更リクエストを通じて行います。

スペースは GitBook の中核的な概念であり、編集ワークフローとセキュリティの両方を支えています。GitBook は権限ベースの編集を適用するため、再利用可能なコンテンツは親スペースからしか変更できません。これにより、組織全体でコンテンツが再利用されていても、編集権限が確実に尊重されます。

既知の制限

Integrations

連携機能によって提供されるブロックは、再利用可能なコンテンツではサポートされていません。これは、GitBook の連携機能がスペースごとにインストールされ、アクセスを制限することでサードパーティの連携機能に付与した権限のみを持たせられるようにしているためです。スペースをまたいで再利用可能なコンテンツを参照すると、このセキュリティ境界が破られてしまいます。

検索

現在、再利用可能なコンテンツは親スペース内の検索結果にのみ表示されます。この制限を取り除き、参照されているあらゆる場所の検索結果に再利用可能なコンテンツが表示されるよう、現在対応を進めています。

アプリ内

再利用可能なコンテンツを作成

再利用可能なコンテンツを作成するには、 1つ以上のブロックを選択し、次に アクションメニュー に移動し、 変換、そして 再利用可能なコンテンツを開きます。あとで見つけて再利用しやすいように、ブロックに名前を付けることもできます。

または、1つ以上のブロックを選択してから Cmd + C を押すと、再利用可能なコンテンツを作成するかどうかを尋ねるプロンプトが開きます。

再利用可能なコンテンツを挿入

他のブロックと同じように再利用可能なコンテンツを挿入できます。空行で / を押して 挿入パレット を開き、コンテンツ名で検索するか、「reusable」と入力して検索します。あるいは、任意のブロックや空行の左側にある + をクリックします。

また、ページのサイドバーにも再利用可能なコンテンツ パネルがあり、現在のスペースで以前作成したコンテンツ ブロックの一覧を確認できます。

再利用可能なコンテンツを編集

再利用可能なコンテンツは他のコンテンツと同じように扱えます。 ライブ編集 が有効なら任意のインスタンスを直接編集でき、そうでない場合は 変更リクエスト を通じて編集できます。加えた変更は、そのコンテンツが使われているすべての場所に同期されます。

変更リクエスト内で変更を行っている場合、その変更リクエストがマージされると、コンテンツは他のすべてのインスタンスに同期されます。

再利用可能なコンテンツの分離

を開いて、再利用可能なコンテンツを分離できます。 アクションメニュー を開いて、 分離。分離すると、コンテンツは通常のブロックに戻ります。

分離後は、そのブロックに加えた変更は他のインスタンスに反映されず、他のインスタンスで加えた変更も分離されたブロックには反映されません。再利用可能なコンテンツの他のすべてのインスタンスは、引き続き相互に同期されたままです。

再利用可能なコンテンツを削除

必要であれば、スペースから再利用可能なコンテンツを完全に削除できます。ページの目次から再利用可能なコンテンツを見つけ、削除したいコンテンツの横にある アクションメニュー を開いて 削除.

再利用可能なコンテンツを削除すると それが使用されているすべてのページから削除されます。この操作は元に戻せません。

GitHub と GitLab との同期

GitHub と GitLab への同期時も、再利用可能なコンテンツは完全にサポートされています。再利用可能なコンテンツは専用の includes フォルダに書き出され、各コンテンツは個別の Markdown ファイルになります。

その後、他のページでは includes ディレクティブ

を使ってコンテンツを参照します。 .gitbook/includes 同期すると、 .gitbook/includes ディレクトリは各同期スペースのルートに作成されます（リポジトリ全体のルートとは限りません）。

例

フォルダまたはそのファイルがスペースの目次に表示される場合は、TOC から手動で非表示にする必要があるかもしれません。

GitHub 側で記述している場合は、include へのパスが参照先を含むファイルからの相対パスであることを確認してください（リポジトリのルートではありません）。