For the complete documentation index, see llms.txt. This page is also available as Markdown.

コンテンツバリエーション

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

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

A GitBook screenshot showing a docs site's structure

複数の言語やバージョンを追加する

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

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

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

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

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

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

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

バリアントを変更する

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

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

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

バリアントのコンテンツを置き換えるには、まずその 編集 The Edit icon in GitBook ボタンをクリックして削除し、その後 削除 モーダルの左下にある バリアントを追加 新しいコンテンツを追加するボタンをクリックします。

バリアントの並べ替え

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

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

既定のバリアントを設定する

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

バリアントを既定に設定するには、 操作メニュー The Actions menu icon in GitBook バリアントの表の行にある 既定に設定.

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

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

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

〜を開き、 操作メニュー The Actions menu icon in GitBook 削除したいバリアントの 削除.

最終更新

役に立ちましたか?