Options
Customise the appearance and behaviour of your website.
You can add options to the second parameter of the addPlugin function in Eleventy config file.
For example, to add a product name to the right of the GOV.UK text in the header, you would add the following:
import { govukEleventyPlugin } from '@x-govuk/govuk-eleventy-plugin'
export default function(eleventyConfig) {
eleventyConfig.addPlugin(govukEleventyPlugin, {
header: {
productName: 'Apply for a juggling licence',
}
})
}
Plugin options
| Name | Type | Description |
|---|---|---|
| footer | object | See options for footer |
| header | object | See options for header |
| homeKey | string | First item in pagination and key to use when referring to the home page for eleventyNavigation.parent (default is Home) |
| icons | object | Override GOV.UK site icons |
| icons.mask | string or boolean | Override GOV.UK SVG mask icon. Use false to not include a mask icon. |
| icons.shortcut | string or boolean | Override GOV.UK favicon. Use false to not include a favicon. |
| icons.touch | string or boolean | Override GOV.UK touch icon. Use false to not include a touch icon. |
| markdown | object | Options for Markdown |
| opengraphImageUrl | string | URL for default Open Graph share image |
| serviceNavigation | object | See options for service navigation |
| showBreadcrumbs | boolean | Show breadcrumb navigation (default is true for nested pages) |
| stylesheets | array | Stylesheets to load instead of default application styles |
| templates | object | Configuration for page templates |
| templates.error404 | object or boolean | Configuration for the 404 page not found template (default is true) |
| templates.feed | object or boolean | Configuration for the RSS feed template (default is false) |
| templates.searchIndex | object or boolean | Configuration for the search index template (default is false) |
| templates.sitemap | object or boolean | Configuration for the sitemap template (default is true) |
| templates.tag | object or boolean | Configuration for the tag templates (default is false) |
| themeColor | string | Browser theme colour. Must be a hex value (default is #0b0c0c) |
| titleSuffix | string | Value to show at the end of the document title (default is GOV.UK) |
| url | string | The URL of your website. Optional, but required to have valid canonical URLs in Open Graph meta data. |
Options for header object
Alongside options available for the header component, the following options can be set:
| Name | Type | Description |
|---|---|---|
| logotype | object | Logo that appears in the header. If no value is provided, the GOV.UK logo is shown. |
| logotype.text | string | Text to show instead of the GOV.UK logo. This text will appear bold. If html is set, this is not required. If html is provided, the text option will be ignored. |
| logotype.html | string | If text is set, this is not required. If html is provided, the text option will be ignored. |
| search | object | See options for search |
Options for serviceNavigation object
Alongside options available for the service navigation component, the following options can be set:
| Name | Type | Description |
|---|---|---|
| search | object | Injects search field into slots.end. See options for search. |
Options for search object
You can show a search field in your site header, or within the service navigation (if enabled).
Follow guidance in the GOV.UK Design System about adding other header and navigation elements to decide which is the best location to use.
| Name | Type | Description |
|---|---|---|
| label | string | Text to show in the search field (default is Search site) |
| indexPath | string | Path to search index file |
| sitemapPath | string | Path to sitemap page, shown as a fallback if the search field cannot be displayed |
Options for footer object
Alongside options available for the footer component, the following options can be set:
| Name | Type | Description |
|---|---|---|
| contentLicence | object | Licence description. If no value is provided, the OGL logo is shown alongside the words All content is available under the Open Government Licence v3.0, except where otherwise stated. Set to false to remove completely. |
| contentLicence.text | string | If html is set, this is not required. If html is provided, the text option will be ignored. |
| contentLicence.html | string | If text is set, this is not required. If html is provided, the text option will be ignored. |
| copyright | object | Copyright statement. If no value is provided, © Crown copyright is displayed below an image of the Royal Coat of Arms. Set to false to remove completely. |
| copyright.text | string | If html is set, this is not required. If html is provided, the text option will be ignored. |
| copyright.html | string | If text is set, this is not required. If html is provided, the text option will be ignored. |
| logo | boolean | Show logo in footer (default is true) |
Options for Markdown
Alongside options for markdown-it, you can also set the following options:
| Name | Type | Description |
|---|---|---|
| headingPermalinks | boolean | Add links to headings, making it easier to share sections of a page (default is false) |
| headingsStartWith | string | Heading size to use for the top-level heading, xl or l (default is xl) |