Skip to main content
Sitemap
Layouts

Front matter options

All layouts can accept the following front matter data to customise their appearance, content and behaviour:

Name Type Description
aside object Small portion of content that is indirectly related to the main content
aside.title string Title for aside
aside.content string Content for aside. Accepts Markdown.
caption string Heading caption that sits above the page title
description string Page description
includeInBreadcrumbs boolean Include page as the last item in any breadcrumbs (default is false)
layout string Page layout to use
opengraphImage object Open Graph image that appears on social media networks
opengraphImage.src string Path to Open Graph image. Can be a relative or absolute URL. This value overrides opengraphImageUrl in plugin options.
opengraphImage.alt string Alternative text for Open Graph image
order integer Ranking of page in navigation. Lower numbers appear before pages with a higher number.
related object See options for related.
related.section array See options for related.
theme string Common title page sits under in sub navigation
title string Page title
Name Type Description
title string Title for group of related links (default is Related content)
items array See options for related items.
subsections array Subsections containing related links
subsections[].title string Title for a subsection of related links
subsections[].items array Related items in a subsection. See options for related items.
Name Type Description
text string Title of related content
href string Link for the related content