コンテンツバリアント

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

最終更新 1 か月前

役に立ちましたか？