コンテンツバリアント

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

1つのドキュメントサイトの一部として、同じドキュメントの複数のバージョンを公開できます。公開されたサイトでは、これらのバリアントは目次の上部にあるバリアントピッカーからエンドユーザーが利用できます。

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

バリアントにはどんなコンテンツでも含められますが、次の用途として使うことをおすすめします 同じコンテンツのバリエーション。コンテンツの意味が異なる場合は、代わりに sections として追加することを検討してください。

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

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

構造エディタを開く サイト構造 サイトのサイドバー内にあります。ここでサイトのすべてのコンテンツを確認できます。

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

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

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

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

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

サイトでは、バリアントはあなたの サイト構造 表に表示される順序で表示されます。バリアントは、 ドラッグハンドル をつかんで上下に移動できます。変更後の順序はすぐにサイトに反映されます。

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

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

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

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

サイトからバリアントを削除するには、 サイト構造 サイトのサイドバーで開き、削除したいコンテンツを見つけます。

次を開き アクションメニュー から削除したいバリアントの構造エディタを開き、削除.

を選択します。バリアントをサイトから削除すると、公開サイトからも削除されますが コンテンツ自体は削除されません — まだ次で見つけることができますすべてのコンテンツ.

最終更新 9 日前

役に立ちましたか？