Accessibility (a11y)

Public sites should check for accessibility issues, using Pa11y.

Automated tests

Create a pa11y.default.json file for the default configuration, for example:

  "defaults": {}

Create a file for the mobile configuration, for example:

  "viewport": {
    "width": 320,
    "height": 480,
    "deviceScaleFactor": 2,
    "isMobile": true

Test individual URLs with pa11y, for example:

pa11y -c pa11y.default.json

If the site has a sitemap, use pa11y-ci, for example:

pa11y-ci -c pa11y.default.json -s

Continuous integration


This section is a stub. For now, see the Data Registry’s a11y.yml workflow file.