Fork me on GitHub


By default, sources are objects represented by each file under source/. In addition to the actual content, these files can provide a YAML frontmatter. Sources that have YAML frontmatter are considered special in that they can be formatted.

What is YAML frontmatter? It is best to compare examples:

# This is a markdown file without YAML frontmatter

... compared to...

layout: default

# This is a markdown file with YAML frontmatter

The frontmatter is the chunk of YAML in the second example. It is delimited by ---. The YAML frontmatter is parsed and injected into every page rendering and is accessible as page.KEY.

Nested Frontmatter YAML Structures

Sculpin reads nested structures in YAML frontmatter. Use a . to indicate that you want to descend into a structure. For example:

layout: default
        very: deep
        also: deep

We can reference `{{ }} === deep`.