Skip to content

Commit 0565530

Browse files
authored
Update docs for v1.0.0 alpha.5 (#70)
* Document `ignoreElements` input * Update changelog for v1.0.0-alpha.5
1 parent 25f04c8 commit 0565530

File tree

2 files changed

+16
-6
lines changed

2 files changed

+16
-6
lines changed

CHANGELOG.md

+7
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
Prior to v1.0.0-alpha.1, logs were generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
99

10+
## [v1.0.0-alpha.5](https://github.com/netlify-labs/netlify-plugin-a11y/compare/v1.0.0-alpha.4...v1.0.0-alpha.5)
11+
12+
### Added
13+
- New input: `ignoreElements`. Used to indicate to the test runner elements which should be ignored during a11y testing.
14+
### Changed
15+
- Lowers minimum required version of Node from `12.13.0` to `12.0.0`.
16+
- Internal: Uses a local server powered by the Node `http` module to host files prior to testing. This local server makes tests more accurate and more secure!
1017
## [v1.0.0-alpha.4](https://github.com/netlify-labs/netlify-plugin-a11y/compare/v1.0.0-alpha.3...v1.0.0-alpha.4)
1118
### Changed
1219
- Added a pre-release notice to the README, as well as other copy cleanup.

README.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -92,12 +92,13 @@ If you want to use the plugin's default settings (check **all** pages of your si
9292
If you've installed the plugin via `netlify.toml`, you can add a `[[plugins.inputs]]` field to change how the plugin behaves. This table outlines the inputs the plugin accepts. All of them are optional.
9393

9494

95-
| Input name | Description | Value type | Possible values | Default value |
96-
|---------------------|----------------------------------------------------------|------------------|-----------------------------------------------|---------------|
97-
| `checkPaths` | Indicates which pages of your site to check | Array of strings | Any directories or HTML files in your project | `['/']` |
98-
| `failWithIssues` | Whether the build should fail if a11y issues are found | Boolean | `true` or `false` | `true` |
99-
| `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 | `'WCAG2A'` or `'WCAGA2A'` or `'WCAG2AAA'` | `'WCAG2AA'` |
95+
| Input name | Description | Value type | Possible values | Default value |
96+
|---------------------|-----------------------------------------------------------|-----------------------|-------------------------------------------------------|---------------|
97+
| `checkPaths` | Indicates which pages of your site to check | Array of strings | Any directories or HTML files in your project | `['/']` |
98+
| `failWithIssues` | Whether the build should fail if a11y issues are found | Boolean | `true` or `false` | `true` |
99+
| `ignoreDirectories` | Directories that *should not* be checked for a11y issues | Array of strings | Any directories in your project | `[]` |
100+
| `ignoreElements` | Indicates elements that should be ignored by a11y testing | String (CSS selector) | Comma-separated string of CSS selectors | `undefined` |
101+
| `wcagLevel` | The WCAG standard level against which pages are checked | String | `'WCAG2A'` or `'WCAGA2A'` or `'WCAG2AAA'` | `'WCAG2AA'` |
101102

102103
Here's how these inputs can be used in `netlify.toml`, with comments to explain how each input affects the plugin's behavior:
103104

@@ -111,6 +112,8 @@ Here's how these inputs can be used in `netlify.toml`, with comments to explain
111112
failWithIssues = false
112113
# Ignore all HTML files in `/admin`
113114
ignoreDirectories = ['/admin']
115+
# Ignore any accessibility issues associated with an element matching this selector
116+
ignoreElements = '.jumbotron > h2'
114117
# Perform a11y check against WCAG 2.1 AAA
115118
wcagLevel = 'WCAG2AAA'
116119
```

0 commit comments

Comments
 (0)