Application: govspeak-preview

A small rails app for previewing the GOV.UK Markdown variant Govspeak

• GitHub: govspeak-preview
• Ownership: #govuk-publishing-platform owns the repo. #govuk-publishing-platform-system-alerts receives automated alerts for this repo.
• Category: Utilities
• Links:
  • govspeak-preview.publishing.service.gov.uk
  • App dashboard: request rates, errors, durations
  • Kibana App Logs (Production, last 3 hours)
  • Kibana Worker Logs (Production, last 3 hours)
  • Argo CD (govspeak-preview)

README

A tiny app for previewing and converting Govspeak.

Govspeak is a Markdown-derived mark-up language used by GOV.UK.

Note that whilst Govspeak Preview is owned by Publishing Platform, the “Visual Editor” component used by Govspeak Preview is owned by the Whitehall Experience team. See repo ownership by team.

Updating the guide

You can find the source files for the guide at guide.md

This guide is for GOV.UK content designers based at GDS.

It shows how Govspeak looks on the GOV.UK website in mainstream formats.

The guide also says when to use the various types of Govspeak, such as the different callout styles.

Running locally

./startup.sh --live

Licence

MIT License