Front matter

Your pages metadata, YAML formatted.

What's a front matter block

A front matter block must be the first thing in a page 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 specify predefined properties (see below for a reference) or even create custom ones of your own. These properties will then be available to you in the page.metadata object.

Front matter predefined properties

Here is the list of predefined front-matter properties.

NameTypeDescription
createdAtDate (ISO string)The date at which the content was created. This is auto-populated when using create page command, otherwise it is guessed from git data.
descriptionstringDescription of the document used in the HTML description meta-tag.
draftbooleanIf true, the content will not be rendered unless the --buildDrafts flag is used.
createdAtDate (ISO string)The date at which the content was created. This is auto-populated when using create page command, otherwise it is guessed from git data.
expiredAtDate (ISO string)The datetime at which the content should no longer be published.
keywordsstring or string[]The meta keywords for the content. Either a comma-separated string or an array of keywords. Used in the HTML keywords meta-tag.
layoutstringLayout used when rendering the content, defaults to default.
titlestringTitle of the document, typically used in html head (<title>). If not defined, Limedocs will use the first <h1> heading as a title if one exists.
updatedAtDate (ISO string)The datetime at which the content was last updated. This is auto-populated when using the create page command, otherwise it is guessed from git data.
weightnumberUsed for ordering your pages and sections.

Edit this page / submit change