Skip to content

Commit 218d791

Browse files
committed
show error mode
1 parent 82eaadc commit 218d791

File tree

4 files changed

+14
-15
lines changed

4 files changed

+14
-15
lines changed

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,12 @@
1-
# Notes
2-
3-
may need the project to locally install `axe-core`, the resolution is
4-
[a little weird](https://github.com/dequelabs/axe-cli/blob/819eaf299affdcb9e8e9ec76b843e231778612c1/lib/utils.js)
5-
6-
this may be a duplicate of https://github.com/netlify/build/pull/294
7-
81
# netlify-plugin-a11y
92

10-
Run axe-cli and fail build if accessibility failures are found.
11-
3+
Run your critical pages through [pa11y](https://github.com/pa11y/pa11y) and fail build if accessibility failures are found.
124

135
> NOTICE: This is an experimental feature. Subject to lots of change.
146
7+
## Demo
8+
9+
https://netlify-plugin-a11y.netlify.com/
1510

1611
## Overview
1712

@@ -21,6 +16,10 @@ Run axe-cli and fail build if accessibility failures are found.
2116

2217
See this plugin being used in this simplified demo site:
2318

19+
You can switch to `resultMode = "warn"` so that builds don't fail:
20+
21+
![image](https://user-images.githubusercontent.com/6764957/77146484-868d4a80-6a61-11ea-84cc-703c2abd6d6e.png)
22+
2423
## Usage
2524

2625
### Prerequisites

0 commit comments

Comments
 (0)