Skip to content

YAML Front Matter

Torbjörn Klatt edited this page Feb 18, 2016 · 5 revisions

All Markdown files and some other files have to start with a YAML Front Matter, a block of YAML formatted data enclosed by lines of three dashes.

Please, make yourself familiar with the YAML syntax.
Don't be scared, it is really easy and intuitive:

---
receipt:     Oz-Ware Purchase Invoice
date:        2012-08-06
customer:
  first_name:   Dorothy
  family_name:  Gale

items:
  - part_no:   A4786
    descrip:   Water Bucket (Filled)
    price:     1.47
    quantity:  4

  - part_no:   E1628
    descrip:   High Heeled "Ruby" Slippers
    size:      8
    price:     133.7
    quantity:  1

specialDelivery:  >
  Follow the Yellow Brick
  Road to the Emerald City.
  Pay no attention to the
  man behind the curtain.
---

Rule #1: In case a page template provides a field with a value, don't change it!

Rule #2: If you don't need one of the given YAML field, leave it empty or remove it.

General Advice for Specific YAML Fields

  • date and update
    The date of a page is the datetime of its first creation and update should be set and updated to the current datetime whenever updates are made to that page. A datetime is always of the form:

    YYYY-MM-DD HH:MM:SS +ZZZZ
    

    where [+-]ZZZZ is the time zone in [+-]HHMM notation relative to UTC. For DST (daylight saving time) in Europe/Berlin, this would be +0200 and for DST in Los Angeles -0700.

    It is valid to omit the time and timezone data and only write the date: YYYY-MM-DD.