Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions _tools/screenshots/examples/axe-violation/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/.quarto/
/_site/
**/*.quarto_ipynb
11 changes: 11 additions & 0 deletions _tools/screenshots/examples/axe-violation/_quarto.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
project:
type: website
render:
- index.qmd

website:
title: "Axe Violation Example"

format:
html:
theme: cosmo
9 changes: 9 additions & 0 deletions _tools/screenshots/examples/axe-violation/index.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Testing Quarto's accessibility checker
format:
html:
axe:
output: document
---

This violates contrast rules: [insufficient contrast.]{style="color: #eee"}.
20 changes: 20 additions & 0 deletions _tools/screenshots/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,26 @@
}
},
"screenshots": [
{
"name": "axe-violation",
"output": "docs/output-formats/images/axe-violation.png",
"source": {
"type": "example",
"project": "examples/axe-violation",
"page": "index.html"
},
"capture": {
"viewport": { "width": 1000, "height": 360 },
"interaction": [
{ "action": "wait", "selector": "[data-quarto-axe-complete]", "timeout": 10000 }
],
"cropBottom": 51
},
"doc": {
"file": "docs/output-formats/html-accessibility.qmd",
"alt": "The rendered webpage with an accessibility violation warning showing 'Serious · WCAG 2.0 AA (1.4.3): Ensure the contrast between foreground and background colors meets WCAG 2 AA minimum contrast ratio thresholds'"
}
},
{
"name": "about-jolla",
"output": "docs/websites/images/about-jolla.png",
Expand Down
2 changes: 1 addition & 1 deletion docs/output-formats/html-accessibility.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Quarto supports two additional output formats for the accessibility checks, avai
output: document
```

With this option, Quarto will generate a visible report of `axe-core` violations on the webpage itself. This is useful for visual inspection of a page. Note that with this setting, Quarto will always produce a report.
With this option, Quarto will generate a visible report of `axe-core` violations on the webpage itself. Each violation displays its WCAG conformance level (e.g., `WCAG 2.0 AA`), so best-practice findings are distinguishable from genuine WCAG failures. This is useful for visual inspection of a page. Note that with this setting, Quarto will always produce a report.

If you wish to use this feature, we recommend adding it to a "debug" [project profile](/docs/projects/profiles.qmd) to reduce the chance you will accidentally publish a website to production with these reports.

Expand Down
Binary file modified docs/output-formats/images/axe-violation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading