コンテンツバリアント

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

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

A GitBook screenshot showing a docs site's structure

複数の言語またはバージョンを追加

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

circle-info

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

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

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

ドキュメントサイトにバリアントを追加する

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

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

バリアントの変更

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

circle-info

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

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

バリアントの並べ替え

サイトは、バリアントがあなたの サイト構造 テーブルに表示されている順序でバリアントを表示します。バリアントは、 ドラッグハンドル The Options menu icon in GitBook を掴んで上下に移動することで並べ替えできます。変更された順序はサイトにすぐ反映されます。

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

デフォルトバリアントの設定

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

バリアントをデフォルトに設定するには、バリアントの行にある 操作メニュー The Actions menu icon in GitBook をクリックし、次に デフォルトに設定.

circle-info

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

サイトからバリアントを削除する

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

を開いて 操作メニュー The Actions menu icon in GitBook を開き、 削除.

circle-check

最終更新

役に立ちましたか?