コンテンツバリアント

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

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

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

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

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

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

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

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

編集したいバリアントの行にある編集ボタンをクリックすると、各バリアントの名前と slug を変更できます。モーダルが開くので、変更したいフィールドを編集し、次に保存ボタンをクリックして保存します。さらに、 バリアントを削除 ボタンを左下でクリックして、バリアントを削除することもできます。

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

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

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

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

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

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

バリアントを既定に設定するには、 アクションメニュー バリアントの行にあるをクリックしてから、 デフォルトに設定.

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

サイトからバリアントを削除するには、設定タブを開き、次に構造をクリックして削除したいコンテンツを見つけます。

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

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

最終更新 26 日前

役に立ちましたか？