NHS.UK Eleventy Plugin • 

Build documentation websites using Markdown and NHS.UK styles.

Requirements

• Node.js v22 or later
• Eleventy v3 or later

Installation

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

Usage

import { nhsukEleventyPlugin } from '@x-govuk/nhsuk-eleventy-plugin'

export default function(eleventyConfig) {
  eleventyConfig.addPlugin(nhsukEleventyPlugin, {
    // 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.