Skip to content

Commit f9b43ad

Browse files
committed
Chore: Add descriptions for each plugin input
1 parent 2d722e6 commit f9b43ad

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

manifest.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@ name: netlify-plugin-a11y
22
inputs:
33
- name: checkPaths
44
default: ['/']
5-
required: false
5+
description: Array of paths (folders or html files) that the plugin should check. Defaults to root (['/']), which checks every html file on your site.
66
- name: failWithIssues
77
default: true
8+
description: Whether the build should faul if the plugin finds a11y issues. Defaults to true.
89
- name: ignoreDirectories
910
default: []
10-
required: false
11+
description: Array of directories whose pages the plugin should ignore when checking for a11y issues. Defaults to [].
1112
- name: standard
1213
default: 'WCAG2AA'
14+
description: The level of WCAG 2.1 against which to check site pages. Defaults to 'WCAGAA'; can also be 'WCAGA' or 'WCAGAAA'.

0 commit comments

Comments
 (0)