https://github.com/x-govuk/govuk-eleventy-plugin

Write documentation using Markdown and publish it using GOV.UK styles.
https://github.com/x-govuk/govuk-eleventy-plugin

eleventy-plugin government govuk govuk-design-system govuk-frontend project

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/x-govuk/govuk-eleventy-plugin
• Owner: x-govuk
• License: mit
• Created: 2019-08-01T23:06:50.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2025-02-01T13:19:10.000Z (over 1 year ago)
• Last Synced: 2025-03-29T00:09:54.588Z (about 1 year ago)
• Topics: eleventy-plugin, government, govuk, govuk-design-system, govuk-frontend, project
• Language: JavaScript
• Homepage: https://x-govuk.github.io/govuk-eleventy-plugin/
• Size: 3.86 MB
• Stars: 59
• Watchers: 3
• Forks: 13
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# GOV.UK Eleventy Plugin • [![test](https://github.com/x-govuk/govuk-eleventy-plugin/actions/workflows/test.yml/badge.svg)](https://github.com/x-govuk/govuk-eleventy-plugin/actions/workflows/test.yml)

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](https://nodejs.org) v22.16 or later

- [Eleventy](https://www.11ty.dev) v3 or later

## Installation

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

## Usage

```js

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

export default function(eleventyConfig) {

  eleventyConfig.addPlugin(govukEleventyPlugin, {

    // Options

  })

}

```

Learn more about how to [get started](https://govuk-eleventy-plugin.x-govuk.org/get-started/) and which [options you can provide](https://govuk-eleventy-plugin.x-govuk.org/get-started/options/).

## 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.