フロントマター
はじめに
Hugoでは、マークダウンファイルの先頭部分に、フロントマターと呼ばれる、メタデータ管理の機能を提供しています。これにより、各コンテンツに、ページ単位のメタデータを定義することができます。
フロントマター
フロントマターは、TOML、YAML、JSON、ORGの4種類の形式で記述することができます。各形式で、フロントマターの開始終了を表す文字列が定められています。
形式 | 説明 |
---|---|
TOML | 開始・終了は、+++ で区切る。 |
YAML | 開始・収量は、--- で区切る。 |
JSON | {} で囲まれた、一つのJSONオブジェクトを配置する。 |
ORG | #+KEY: VALUE形式で記述する。#+ 以外で始まる文字列が現れた時点で終了する。 |
変数には、Hugoにより事前定義されたものがあります。それ以外の変数は、ユーザが定義することができます。
フロントマターで定義した変数は、テンプレートやショートコード内で参照することができます。ユーザが定義した変数は、.Params という変数にまとめて入れられます。テンプレートからは、以下のようにして参照することができます。
|
|
|
|
あたりまえですが、フロントマターはHTMLファイルには現れません。
最終更新日
March 21, 2022