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:

Common front matter options
Name Type Description
layout string Page layout.
includeInBreadcrumbs boolean

Include page as the last item in any breadcrumbs (default is false).

title string Page title.
caption string Heading caption that sits above the page title.
description string Page description.
order integer Ranking of page in navigation. Lower numbers appear before pages with a higher number.
theme string

Common title page sits under in sub navigation.

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.
related object

Related links section. See section.

related.sections Array

Multiple related links sections. See section.

Options for section
Name Type Description
title string Title for group of related links (default is ‘Related content’).
items Array

Related link items. See items.

Options for items
Name Type Description
text string Title of related content.
href string Link for the related content.