Skip to content

Commit 096ac67

Browse files
authored
Document alt-text plugin in Plugins section (#247)
2 parents 72f473f + 28456f9 commit 096ac67

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,18 @@ The a11y scanner leverages GitHub Copilot coding agent, which can be configured
180180

181181
## Plugins
182182

183-
See the [plugin docs](https://github.com/github/accessibility-scanner/tree/main/PLUGINS.md) for more information
183+
See the [plugin docs](https://github.com/github/accessibility-scanner/tree/main/PLUGINS.md) for more information, including how to load plugins published to npm.
184+
185+
### Alt Text Plugin
186+
187+
The [Alt Text Plugin](https://github.com/github/accessibility-scanner-alt-text-plugin) is a first-party scanner plugin published to npm as [`@github/accessibility-scanner-alt-text-plugin`](https://www.npmjs.com/package/@github/accessibility-scanner-alt-text-plugin). It flags low-quality `alt` text that can pass Axe's `image-alt` rule, including vague or generic descriptions, raw filenames, repeated text, and placeholder values. The scanner installs the package at runtime; to enable it, add the plugin to the `scans` input using its package name:
188+
189+
```yaml
190+
scans: |
191+
["axe", {"name": "alt-text-scan", "package": "@github/accessibility-scanner-alt-text-plugin", "version": "1.0.0"}]
192+
```
193+
194+
See the [plugin README](https://github.com/github/accessibility-scanner-alt-text-plugin#getting-started) for the current release version, full rule list, and setup instructions.
184195
185196
---
186197

0 commit comments

Comments
 (0)