Skip to content

⌗ Front Matter

Front matter allows page-specific metadata and functionality to be included at the top of a Markdown file.

In the documentation and the example site, we will predominantly use YAML to format the front matter of content files and the configuration files. This is because YAML is a popular configuration syntax used by most website generators and is also supported by all popular Markdown editors.

Easily Edit your content on the go or from the comfort of your sofa** with the integrated open source CMS and the built-in GitHub editor. Refer to the Choose an Editor guide to learn more.

Page options (front matter) are defined in YAML syntax between triple-minus --- lines at the top of your Markdown content files.

The front matter may include metadata such as page title, date published, author, categories, tags, and so on. Here is a simple YAML front matter example:

title: My first blog post
summary: A description of my page for search engines.
date: 2023-12-01