johnnolan/govuk-eleventy-plugin

Write documentation using Markdown and publish it using GOV.UK styles.

GOV.UK Eleventy Plugin • 

Build documentation websites using Markdown and GOV.UK styles.

You’re welcome to use the plugin even if your service isn’t considered part of GOV.UK, but your site or service must not:

• identify itself as being part of GOV.UK
• use the crown or GOV.UK logotype in the header
• use the GDS Transport typeface
• suggest that it’s an official UK government website if it’s not

Requirements

• Node.js v16.0.0 or above
• npm CLI v8.0.0 or above
• Eleventy v2.0.0 or above

Installation

npm install @x-govuk/govuk-eleventy-plugin

Usage

const govukEleventyPlugin = require('@x-govuk/govuk-eleventy-plugin')

eleventyConfig.addPlugin(govukEleventyPlugin, {
  // Options
})

Learn more about how to get started and which options you can provide.