コンテンツバリアント

複数の製品バージョンや言語向けのドキュメントを 1 つのサイトで公開します

1つのドキュメントサイトの一部として、同じドキュメントの複数バージョンを公開できます。これらのバリアントは、公開サイトの左上にあるスペース切り替えメニューから、エンドユーザーが利用できます。

複数のバリアントを持つサイトは、API の複数バージョン（v1、v2、v3 など）を文書化する場合や、異なる言語でコンテンツを文書化する場合など、スペースのコンテンツをまとめる必要があるときに便利です。

リンクするスペースにはどのようなコンテンツでも含められますが、バリアントは 同じコンテンツのバリエーションとして使うことをおすすめします。リンクするスペース同士の意味が異なる場合は、代わりにそれらをサイトセクションとして追加することを検討してください。

翻訳版や複数言語をバリアントとして追加する場合は、ドキュメントを閲覧するユーザーに最適な体験を提供するため、バリアントの言語を設定するのがベストプラクティスです。

言語を設定した複数のバリアントを追加すると、言語ピッカーは右上に移動し、既定のバリアントピッカーよりもすっきりとした、より直接的な体験になります。

ドキュメントサイトのダッシュボードで、設定タブをサイトヘッダーで開き、次に構成をクリックします。ここでサイトのすべてのコンテンツを確認できます。

バリアントを追加するには、追加したいセクションで バリアントを追加 ボタンをクリックし、リンクするスペースを選択します。新しいバリアントは選択したセクション内のバリアント一覧に追加され、サイト上のバリアントのドロップダウンから訪問者が利用できるようになります。

各バリアントの名前とスラッグは、編集したいバリアントのテーブル行にある編集ボタンをクリックして変更できます。モーダルが開きます。変更したい項目を編集し、次に保存ボタンをクリックして保存します。バリアントを削除するには、 バリアントを削除 ボタンを左下でクリックすることもできます。

サイトが複数言語をサポートしている場合は、バリアントのタイトルを翻訳して、ピッカーにローカライズされたラベルを表示することもできます。参照多言語セクション.

リンクされたスペースのスラッグを変更すると、そのスペースの正規URLが変更されます。GitBook は古いURLから新しいURLへの自動リダイレクトを作成します。さらに、リダイレクトを手動で作成する.

バリアントにリンクされているスペースを別のスペースに置き換えるには、まずそのスペースの編集ボタンをクリックして削除し、次に削除ボタンをモーダルの左下でクリックします。バリアントが削除されたら、 バリアントを追加 ボタンをクリックして新しいスペースを追加します。

サイトには、 サイト構成 テーブルに表示される順序でバリアントが表示されます。バリアントは、 ドラッグハンドル をつかんで上下に移動することで並べ替えられます。変更された順序はすぐにサイトに反映されます。

キーボードを使ってコンテンツを選択・移動することもできます。スペースバーでセクションまたはバリアントを選択し、矢印キーで上下に移動します。もう一度スペースバーを押して、新しい位置を確定します。

1つのセクション内に複数のバリアントがある場合、1つが既定としてマークされます。訪問者がサイトにアクセスしたとき（またはセクションを訪れたとき）に、このバリアントが表示されます。他のバリアントにはそれぞれスラッグがあり、サイトのURLの末尾に追加されます。

バリアントを既定に設定するには、 アクションメニュー をバリアントのテーブル行でクリックし、次に 既定に設定.

をクリックします。バリアントを既定に設定すると、そのスラッグ欄は削除され、代わりにセクションのルートから配信されます。GitBook は、訪問者が引き続きコンテンツを閲覧できるよう、バリアントのスラッグを適切なパスへリダイレクトします。

サイトからバリアントを削除するには、ドキュメントサイトのダッシュボードで設定タブを開き、次に構成をクリックして削除したいコンテンツを見つけます。

を開き、 アクションメニュー 削除したいバリアントの削除.

サイトからバリアントを削除すると、公開サイトからは削除されますが、 スペースやその中のコンテンツは削除されません.

最終更新 9 日前

役に立ちましたか？