コンテンツへスキップ
uencoder

Frontmatter

フロントマター（Frontmatter）は、文書の先頭に置かれる --- で区切られた YAML/TOML/JSON メタデータブロックであり、静的サイトジェネレーターで広く使用される。

目的

Markdown 系文書の本体の前に構造化メタデータを付与し、サイト生成とコンテンツ管理を容易にする。

メカニズム

文書は --- で始まり、YAML（または TOML/JSON）メタデータが続き、--- で終わり、その後に本体が続く。パーサーはフロントマターと本体を分離する。Jekyll、Hugo、Astro が広く使用している。

ユースケース

  • Astro/Hugo/Jekyll の記事メタデータ
  • Markdown ブログのフロントマター
  • ドキュメントサイトの設定
  • CMS コンテンツ管理

例

  • 入力 
    ---
title: Hello
---
# Body
    Output 
    meta {title:"Hello"} + body

    YAML frontmatter

よくあるエラー

A frontmatter syntax error breaks parsing
Check it with a validator for the corresponding format

関連用語

YAML
YAML（YAML Ain't Markup Language）は、設定向けのデータ直列化形式で、インデントで階層を表し、コメントと参照をサポートし、JSONよりも手書き編集に適する。
用語集
TOML
TOML（Tom's Obvious, Minimal Language）は設定向けのフォーマットで、テーブルとキーと値のペアでデータを表現する。明示的な意味を持ち、暗黙の型推論はない。
用語集
JSON
JSON（JavaScript Object Notation）は、JavaScript のオブジェクトリテラルに基づく軽量なデータ交換形式である。キー・バリューペアと配列を使う。
用語集
YAML Frontmatter
YAML フロントマター（YAML Frontmatter）は、Markdown ファイルの先頭に置かれる --- で区切られた YAML ブロックであり、文書のメタデータ（タイトル、日付、タグ）を格納する。
用語集

References