Skip to content

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

License

Notifications You must be signed in to change notification settings

x-govuk/govuk-eleventy-plugin

Repository files navigation

GOV.UK Eleventy Plugin • test

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

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.

Releasing a new version

npm run release

This command will ask you what version you want to use. It will then publish a new version on NPM, create and push a new git tag and then generate release notes ready for posting on GitHub.

Note

Releasing a new version requires permission to publish packages to the @x-govuk organisation.