YAML Frontmatter（ヤムルフロントマター）とは、Markdown 形式のファイルの先頭に YAML 形式で記述された メタデータ のこと。
概要
YAML Frontmatter は、Markdown 形式のファイルにメタデータを記述することで、Markdown だけでは表現できない情報を記述することができる。
主に Static Site Generator で普及しており、Jekyll や Hugo などが代表的な例である。
記述方法
YAML Frontmatter は、ファイルの先頭に --- で囲まれた YAML 形式のデータを記述する。
例として、このページには以下のような YAML Frontmatter が記述されている。
---
title: YAML Frontmatter
description: YAML Frontmatterは、Markdownファイルのためのメタデータ形式である。
permalink: yaml-frontmatter
draft: false
tags:
- Quartz
- Obsidian
---YAML Frontmatter に記述できる項目は、ウェブサイトやアプリケーションによって異なり、自由に定義することができる。
Quartz での利用
Quartz では、主に以下のような項目が利用可能である。
title: ページのタイトル。description: ページの説明。検索エンジンやソーシャルメディアでのプレビューに使用される。permalink: ページのカスタム URL。aliases: ページのエイリアス。tags: ページに関連するタグ。draft: ページが下書き状態かどうかを示すブール値。date: ページが公開された日付。
その他の項目については、詳細については Quartz のドキュメント を参照のこと。