How to embed your a14y badge

1. Get your embed snippet

1. From the leaderboard. Find your site on the public leaderboard and click Badge on its row. The badge page opens pre-filled with your latest score.
2. From the CLI. Run npx a14y check yoursite.com --scorecard 0.3.0-draft. The CLI prints a shareable badge URL when the scan finishes. Open it.
3. From the Chrome extension. Run a scan, then click Share score → Embed badge. The badge page opens with the snippet ready to copy.

2. Pick a theme

Light and dark are the two options. The theme picker on the badge page updates the snippet and the URL together, so the copied HTML matches what you see in the preview.

The badge is a self-contained SVG inside the HTML. It does not respect the embedding site's dark-mode toggle on its own. Pick the theme that matches the page where the badge will live.

3. Paste it in

Common spots:

HTML page (docs, marketing site, blog post)

Paste the snippet into the HTML where the badge should appear. The snippet brings its own inline styles, so it does not inherit your site's typography.

GitHub or GitLab README

The snippet is HTML, and GitHub renders inline HTML inside markdown. Paste it directly into your README.md. If your platform does not allow inline HTML (e.g. PyPI long descriptions, npm READMEs in some renderers), use the markdown-image fallback below.

Markdown-only environments (npm, PyPI, etc.)

Image-only badges are not yet supported as a first-class export. For now, screenshot the rendered badge from the /badge/ page and host it next to your README. An SVG-only variant is tracked at TJ-747.

Footer or about page

The badge is ~280 by ~120 pixels at default scale. It fits cleanly into a footer "credibility row" alongside other status badges.

4. Keep it fresh

Scores can change as your site changes and as the scorecard evolves. Re-run npx a14y check yoursite.com --scorecard 0.3.0-draft whenever you ship a significant docs change, paste the new snippet in, and the embed updates.

Each badge snapshot is pinned to a scorecard version (the v= param in the URL). If you embed a badge for v0.2.0 and we later release v0.3.0, your existing embed keeps rendering against v0.2.0 until you replace it.