From b2dd786f3c0e924c63d2c8e4f32100a412c364c4 Mon Sep 17 00:00:00 2001 From: ncastejon <castejon.nicolas@gmail.com> Date: Tue, 28 May 2019 11:09:24 +0200 Subject: [PATCH] Add accessibilite documentation: pa11y for testing --- accessibility.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 accessibility.md diff --git a/accessibility.md b/accessibility.md new file mode 100644 index 0000000..3f7da67 --- /dev/null +++ b/accessibility.md @@ -0,0 +1,41 @@ +# Testing with pa11y + +This [resource](https://bitsofco.de/pa11y/) is a good start to create your own testing pipeline. + + + +## Quick and simple overview +``` +npm install -g pa11y +``` +``` +pa11y https://data.beta.grandlyon.com/fr/accueil +``` + +## Display only critical errors +``` +pa11y https://data.beta.grandlyon.com/fr/accueil --ignore "warning;notice" +``` + +## Using the pa11y-ci +``` +npm install -g pa11y-ci +``` + +Then create a **.pa11y1** json file. +``` +{ + "urls": [ + "https://data.beta.grandlyon.com/fr/accueil" + ] +} +``` +To run the report on multiple URLs: +``` +pay11-ci +``` + +It is also possible to save the report as a json file: +``` +pay11-ci --json > report.json +``` \ No newline at end of file -- GitLab