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 TOML to format the configuration files. This is because TOML is more human-friendly but popular Markdown editors primarily support YAML front matter in content files.

For editing your content locally on your computer, we recommend Typora or Visual Studio Code.

If a content file has front matter variables set between triple-minus --- lines, then it is YAML formatted. Otherwise, a content file will have variables set between triple-plus +++ lines, indicating that it is TOML formatted.

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:

---
date: 2017-12-01
title: My first blog post
---

If you wish to convert between formats, a handy online YAML<–>TOML converter is available.

Next