フロントマター

フロントマターは、各ファイルの先頭にある3つのダッシュで区切られたYAMLコードで、コンテンツの重要な管理オプションを提供します。たとえば、フロントマターを使用すると、移動または完全に削除されたページでも既存のリンクが機能し続けるようにできます。このページでは、Istioのフロントマターで現在利用可能な機能について説明します。

次の例は、プレースホルダーで埋められたすべての必須フィールドを含むフロントマターを示しています

---
title: <title>
description: <description>
weight: <weight>
keywords: [<keyword1>,<keyword2>,...]
aliases:
    - <previously-published-at-this-URL>
---

上記の例をコピーして、すべてのプレースホルダーをページの適切な値に置き換えることができます。

必須のフロントマターフィールド

次の表に、すべての**必須**フィールドの説明を示します

ページの名称変更、移動、削除

ページを移動したり、完全に削除したりする場合は、そのページへの既存のリンクが引き続き機能するようにする必要があります。フロントマターのaliasesフィールドは、この要件を満たすのに役立ちます。移動または削除前のページのパスをaliasesフィールドに追加してください。Hugoは、ユーザー向けに古いURLから新しいURLへの自動リダイレクトを実装します。

ユーザーを誘導したいターゲットページで、元のページの<path>をフロントマターに次のように追加します。

aliases:
    - <path>

例えば、過去にはFAQページが/help/faqに存在していました。ユーザーがFAQページを見つけやすくするために、ページを1つ上の階層の/faq/に移動し、フロントマターを次のように変更しました。

---
title: Frequently Asked Questions
description: Questions Asked Frequently.
weight: 13
aliases:
    - /help/faq
---

上記変更により、ユーザーはhttps://istio.dokyumento.jp/faq/またはhttps://istio.dokyumento.jp/help/faq/にアクセスした際にFAQにアクセスできます。

複数のリダイレクトもサポートされており、例えば次のようになります。

---
title: Frequently Asked Questions
description: Questions Asked Frequently.
weight: 13
aliases:
    - /faq
    - /faq2
    - /faq3
---

オプションのフロントマターフィールド

ただし、Hugoは多くのフロントマターフィールドをサポートしており、このページではistio.ioで実装されているもののみを扱います。

以下の表は、最も一般的に使用されるオプションフィールドを示しています。

いくつかのフロントマターフィールドは、自動生成される目次（ToC）を制御します。以下の表に、フィールドとその使用方法を示します。

いくつかのフロントマターフィールドは、いわゆるバンドルページにのみ適用されます。ファイル名がアンダースコア_で始まる（例：_index.md）ため、バンドルページを識別できます。Istioでは、バンドルページをセクションのランディングページとして使用しています。以下の表に、バンドルページに関連するフロントマターフィールドを示します。

同様に、いくつかのフロントマターフィールドは、特にブログ投稿に適用されます。以下の表に、これらのフィールドを示します。