Layouts
Choose a layout to match the content you want to write.
The GOV.UK Eleventy Plugin provides different layouts you can choose from, which you can use on different parts of your site:
-
Collection – Layout for a paginated list of pages.
-
Page – Simple layout designed for maximum flexibility of content.
-
Page with sub navigation – Layout with sub navigation.
-
Post – Layout for date-based content, such as blog posts or news items.
-
Product page – Layout for product and marketing pages.
The plugin also provides the following layouts used by features. It’s unlikely you will need to use these for content pages:
Overriding layouts
Layouts provided by this plugin can be overridden, or used as a basis for your own, by using Nunjuck’s template inheritance feature.
For example, to show a message at the top of each page that uses the page layout, add a file named _includes/page.njk with the following content:
{# Extend a plugin layout #}
{% extends "layouts/page.njk" %}
{# Load any GOV.UK Frontend components #}
{% from "govuk/components/inset-text/macro.njk" import govukInsetText %}
{# Override the `content` block #}
{% block content %}
{{ appDocumentHeader({
title: title,
description: description
}) }}
{% if reviewed and reviewAgain %}
{% call govukInsetText() %}
<p class="govuk-body">
{# Use front matter data and call plugin filters #}
This page was last reviewed on {{ reviewed | govukDate }}.<br>
It needs to be reviewed again on {{ reviewAgain | govukDate }}.
</p>
{% endcall %}
{% endif %}
{{ appProseScope(content) if content }}
{% endblock %}
You can extend the following layouts:
layouts/base.njklayouts/collection.njklayouts/error.njklayouts/feed.njklayouts/page.njklayouts/post.njklayouts/product.njklayouts/sitemap.njklayouts/sub-navigation.njklayouts/tag.njklayouts/tags.njk
Replacement layouts must share the same name and saved in your configured layout directory.
Learn more about layouts on the Eleventy website.