Documentation
auditmysite audits rendered web pages against WCAG 2.2 AA through Chrome's accessibility tree and writes JSON and PDF reports. Start with the installation, then pick the mode that fits your task.
Where to start
- Installation — installer script, crates.io, release binaries, building from source.
- Quickstart — a first audit, a JSON report for CI, a first batch run.
Guides
- CLI modes — single URL, sitemap, URL file, crawl, per-page reports, path filters, exit codes.
- Reports — the JSON contract, the PDF report, languages,
report-lint. - Technician mode — one JSON per page,
index.json,findings.jsonl, path globs. - Display modes — audit the calm, text or visual mode of the
data-displayconvention. - Excluding specimens —
data-audit-excludeand--exclude-selector, listed in the report. - Browser setup — which Chrome is used and how to install one.
- Troubleshooting — common errors and what to do about them.
Concepts and reference
- Architecture — the audit pipeline and the shared barrierlab libraries.
- Reference — library API on docs.rs, JSON schemas, contracts in the repository.
Release notes
Each release has notes on GitHub Releases. The changelog lists the changes of each release. The development history keeps the detailed log (in German): each entry records a finding, the fix and how it was verified.