Skip to content

[Sync to prerelease] Document axe standard and best-practice options - #2132

Merged
cwickham merged 1 commit into
prereleasefrom
sync-2105-to-prerelease
Jul 30, 2026
Merged

[Sync to prerelease] Document axe standard and best-practice options#2132
cwickham merged 1 commit into
prereleasefrom
sync-2105-to-prerelease

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Description

Sync of #2105 to prerelease.

Original PR

Document axe standard and best-practice options

Documents the new axe scoping options for Quarto 1.10 on docs/output-formats/html-accessibility.qmd:

  • New section "Checking against a WCAG conformance level": the standard option (nine WCAG version+level values, cumulative semantics), its two side effects (default-disabled rules for the chosen level run, e.g. AAA contrast and WCAG 2.2 target size; best-practice rules are excluded), and best-practice: true/false in both combinations. Links axe-core's rule descriptions for the full rule list.
  • Updates the "Planned work" CDN sentence: axe-core is bundled with Quarto as of 1.10, so checks work offline.
  • Adds fig-alt to the two example screenshots — an axe site audit of this very page flagged them as missing alt text.

Documents quarto-dev/quarto-cli#14682 (standard/best-practice, quarto-dev/quarto-cli#14607) and quarto-dev/quarto-cli#14677 (vendored axe-core). Should merge after those land; draft until then.

* Document axe standard and best-practice options

Adds a section on scoping accessibility checks to a WCAG conformance
level (quarto-dev/quarto-cli#14607, quarto-dev/quarto-cli#14682) and
updates the CDN note now that axe-core is bundled with Quarto 1.10
(quarto-dev/quarto-cli#14677).

Also adds fig-alt to the two example screenshots — an axe site audit
of this page flagged them as missing alt text (the bracket text of a
figure becomes the caption, not the alt).

* Clarify that choosing a standard never adds deprecated rules

* Update axe overlay fig-alt to describe severity and conformance label

* Add prerelease callout for 1.10 axe options

* Remove prerelease callout shortcode

* Replace introduced-in callout notes with prerelease-callout shortcodes

* Simplify

* Dedent best-practice YAML example left over from removed bullet list

* Reorganize accessibility page around interactive and site-wide checks

- Promote the interactive workflow to its own section and move the
  example up into it, with a new DevTools console screenshot for the
  default axe: true output
- Rename Customization to Output location and attach the existing
  overlay screenshots to output: document
- Reframe Planned work as Site-wide accessibility checks
- Add capture-axe-devtools.mjs (window-ID capture of headed Chromium
  with DevTools open) and a console.qmd example page

* Register manual captures in the screenshot manifest

Adds a manual array to manifest.json for screenshots capture.js can't
produce (currently axe-console, which needs the DevTools panel). The
schema validates entries, --list and list.js show them, and
--name <manual-entry> points at the producing script instead of failing.

(cherry picked from commit 6979d02)
@cderv

cderv commented Jul 30, 2026

Copy link
Copy Markdown
Member

/deploy-preview

@github-actions

Copy link
Copy Markdown
Contributor Author

📝 Preview Deployment

🔍 Full site preview: https://deploy-preview-2132.quarto.org

🔄 Modified Documents

@cwickham
cwickham merged commit e726f32 into prerelease Jul 30, 2026
@cwickham
cwickham deleted the sync-2105-to-prerelease branch July 30, 2026 17:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants