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 |
| layout | string | Page layout |
| 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 |
| 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 |
| theme | string | Common title page sits under in sub navigation |
| title | string | Page title |
| related | object | Related links section. See section. |
| related.sections | Array | Related links sections. See section. |
| Name | Type | Description |
|---|---|---|
| title | string | Title for group of related links (default is `Related content`) |
| items | Array | See 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 items. |
| Name | Type | Description |
|---|---|---|
| text | string | Title of related content |
| href | string | Link for the related content |