The front matter is where Jekyll starts to get really cool. Any file that contains a YAML front matter block will be processed by Jekyll as a special file. The front matter must be the first thing in the file and must take the form of valid YAML set between triple-dashed lines. Here is a basic example:
--- layout: post title: Blogging Like a Hacker ---
Between these triple-dashed lines, you can set predefined variables (see below for a reference) or even create custom ones of your own. These variables will then be available to you to access using Liquid tags both further down in the file and also in any layouts or includes that the page or post in question relies on.
UTF-8 Character Encoding Warning
If you use UTF-8 encoding, make sure that no
BOMheader characters exist in your files or very, very bad things will happen to Jekyll. This is especially relevant if you’re running Jekyll on Windows.
ProTip™: Front Matter Variables Are Optional
If you want to use Liquid tags and variables but don’t need anything in your front matter, just leave it empty! The set of triple-dashed lines with nothing in between will still get Jekyll to process your file. (This is useful for things like CSS and RSS feeds!)
There are a number of predefined global variables that you can set in the front matter of a page or post.
| Variable | Description |
|---|---|
|
| If set, this specifies the layout file to use. Use the layout file name without the file extension. Layout files must be placed in the
|
|
| If you need your processed blog post URLs to be something other than the site-wide style (default |
|
| Set to false if you don’t want a specific post to show up when the site is generated. |
ProTip™: Render Posts Marked As Unpublished
To preview unpublished pages, simply run `jekyll serve` or `jekyll build` with the `--unpublished` switch. Jekyll also has a handy drafts feature tailored specifically for blog posts.
Any variables in the front matter that are not predefined are mixed into the data that is sent to the Liquid templating engine during the conversion. For instance, if you set a title, you can use that in your layout to set the page title:
<!DOCTYPE HTML>
<html>
<head>
<title>{{ page.title }}</title>
</head>
<body>
…
These are available out-of-the-box to be used in the front matter for a post.
| Variable | Description |
|---|---|
|
| A date here overrides the date from the name of the post. This can be used to ensure correct sorting of posts. A date is specified in the format |
|
| Instead of placing posts inside of folders, you can specify one or more categories that the post belongs to. When the site is generated the post will act as though it had been set with these categories normally. Categories (plural key) can be specified as a YAML list or a space-separated string. |
|
| Similar to categories, one or multiple tags can be added to a post. Also like categories, tags can be specified as a YAML list or a space-separated string. |
ProTip™: Don't repeat yourself
If you don't want to repeat your frequently used front matter variables over and over, just define defaults for them and only override them where necessary (or not at all). This works both for predefined and custom variables.
© 2008–2018 Tom Preston-Werner and Jekyll contributors
Licensed under the MIT license.
https://jekyllrb.com/docs/frontmatter/