コンテンツへスキップ
uencoder

YAML Frontmatter

YAML フロントマター(YAML Frontmatter)は、Markdown ファイルの先頭に置かれる --- で区切られた YAML ブロックであり、文書のメタデータ(タイトル、日付、タグ)を格納する。

目的

Markdown 文書に構造化メタデータを埋め込み、静的サイトジェネレーター(Hugo、Jekyll)がページ属性を抽出できるようにする。

メカニズム

ファイルは --- で始まり YAML ブロックを開き、2 番目の --- で閉じて、その後に Markdown 本体が続く。パーサーは YAML メタデータと Markdown コンテンツを分離し、メタデータをオブジェクトとしてパースする。

ユースケース

  • 静的サイトジェネレーター
  • ブログ記事のメタデータ
  • ドキュメントサイト

関連ツール

References