@@ -16,7 +16,7 @@ If issues are found, the plugin generates a report which provides:
1616- the total number of issues on the page
1717- the sum of * all* issues across * all* pages that were checked
1818
19- By default, the plugin checks ** all** your site's pages for violations of WCAG 2.1 level AA, and fail the site build if any a11y issues are found.
19+ By default, the plugin checks ** all** your site's pages for violations of WCAG 2.1 level AA, and fails the site build if any a11y issues are found.
2020## Demo
2121
2222The demo site is an Eleventy blog containing some pages that have accessibility issues: https://netlify-plugin-a11y-demo.netlify.com/
@@ -97,7 +97,7 @@ If you've installed the plugin via `netlify.toml`, you can add a `[[plugins.inpu
9797| ` checkPaths ` | Indicates which pages of your site to check | Array of strings | Any directories or HTML files in your project | ` ['/'] ` |
9898| ` failWithIssues ` | Whether the build should fail if a11y issues are found | Boolean | ` true ` or ` false ` | ` true ` |
9999| ` ignoreDirectories ` | Directories that * should not* be checked for a11y issues | Array of strings | Any directories in your project | ` [] ` |
100- | ` wcagLevel ` | The WCAG standard level against which pages are checked | String | ` 'WCAGA ' ` or ` 'WCAGAA ' ` or ` 'WCAGAAA ' ` | ` 'WCAGAA' ` |
100+ | ` wcagLevel ` | The WCAG standard level against which pages are checked | String | ` 'WCAG2A ' ` or ` 'WCAGA2A ' ` or ` 'WCAG2AAA ' ` | ` 'WCAG2AA' ` |
101101
102102Here's how these inputs can be used in ` netlify.toml ` , with comments to explain how each input affects the plugin's behavior:
103103
@@ -112,5 +112,5 @@ Here's how these inputs can be used in `netlify.toml`, with comments to explain
112112 # Ignore all HTML files in `/admin`
113113 ignoreDirectories = [' /admin' ]
114114 # Perform a11y check against WCAG 2.1 AAA
115- wcagLevel = ' WCAGAAA '
115+ wcagLevel = ' WCAG2AAA '
116116```
0 commit comments