dan
/
jekyll
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
jekyll/docs/_docs/front-matter.md

6.0 KiB
Raw Blame History

title permalink redirect_from
Front Matter /docs/front-matter/ /docs/frontmatter/index.html

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 BOM header 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!)

Predefined Global Variables

There are a number of predefined global variables that you can set in the front matter of a page or post.

Variable Description

layout

 

      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
      <code>_layouts</code> directory.

    </p>
    <ul>
      <li>
        Using <code>null</code> will produce a file without using a layout
        file. This is overridden if the file is a post/document and has a
        layout defined in the <a href="/docs/configuration/front-matter-defaults/">
        front matter defaults</a>.
      </li>
      <li>
        Starting from version 3.5.0, using <code>none</code> in a post/document will
        produce a file without using a layout file regardless of front matter defaults.
        Using <code>none</code> in a page will cause Jekyll to attempt to
        use a layout named "none".
      </li>
    </ul>
  </td>
</tr>
<tr>
  <td>
    <p><code>permalink</code></p>
  </td>
  <td>
    <p>

      If you need your processed blog post URLs to be something other than
      the site-wide style (default <code>/year/month/day/title.html</code>), then you can set
      this variable and it will be used as the final URL.

    </p>
  </td>
</tr>
<tr>
  <td>
    <p><code>published</code></p>
  </td>
  <td>
    <p>
      Set to false if you don’t want a specific post to show up when the
      site is generated.
    </p>
  </td>
</tr>
ProTip™: Render Posts Marked As Unpublished

To preview unpublished pages, run `jekyll serve` or `jekyll build` with the `--unpublished` switch. Jekyll also has a handy drafts feature tailored specifically for blog posts.

Custom Variables

You can also set your own front matter variables you can access in Liquid. For instance, if you set a variable called food, you can use that in your page:

{% raw %}

---
food: Pizza
---

<h1>{{ page.food }}</h1>

{% endraw %}

Predefined Variables for Posts

These are available out-of-the-box to be used in the front matter for a post.

Variable Description

date

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 YYYY-MM-DD HH:MM:SS +/-TTTT; hours, minutes, seconds, and timezone offset are optional.

category

categories

 

      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 <a
      href="https://en.wikipedia.org/wiki/YAML#Basic_components">YAML list</a> or a
      space-separated string.

    </p>
  </td>
</tr>
<tr>
  <td>
    <p><code>tags</code></p>
  </td>
  <td>
    <p>

      Similar to categories, one or multiple tags can be added to a post.
      Also like categories, tags can be specified as a <a
      href="https://en.wikipedia.org/wiki/YAML#Basic_components">YAML list</a> or a
      space-separated string.

    </p>
  </td>
</tr>
ProTip™: Don't repeat yourself

If you don't want to repeat your frequently used front matter variables over and over, define defaults for them and only override them where necessary (or not at all). This works both for predefined and custom variables.