Skip to content

Document alt-text plugin in Plugins section #247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kzhou314 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Document alt-text plugin in Plugins section #247

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2f157b4
Document alt-text plugin in Plugins section
kzhou314 Jul 7, 2026
92e55ab
Make section less dense/more readable
kzhou314 Jul 7, 2026
40bcff5
Merge branch 'main' into document-alt-text-plugin
kzhou314 Jul 7, 2026
752cdcb
Wording changes
kzhou314 Jul 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,18 @@ The a11y scanner leverages GitHub Copilot coding agent, which can be configured

## Plugins

See the [plugin docs](https://github.com/github/accessibility-scanner/tree/main/PLUGINS.md) for more information
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.

### Alt Text Plugin

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:

```yaml
scans: |
["axe", {"name": "alt-text-scan", "package": "@github/accessibility-scanner-alt-text-plugin", "version": "1.0.0"}]
```

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.

---

Expand Down
Loading