Add standard and best-practice options to axe (#14607)

news/changelog-1.10.md

@@ -18,6 +18,7 @@ All changes included in 1.10:
 - ([#14468](https://github.com/quarto-dev/quarto-cli/issues/14468)): The `axe` accessibility report UI (HTML overlay, revealjs report slide, dashboard offcanvas) now uses its own theme-independent colors instead of inheriting from `brand` or theme. Keeps the report readable regardless of page styling, and stops `axe` from clobbering brand colors set via `_brand.yml`.
 - ([#14602](https://github.com/quarto-dev/quarto-cli/pull/14602), [#14632](https://github.com/quarto-dev/quarto-cli/pull/14632)): Fix ORCID profile link having no accessible name for screen readers in HTML, Reveal.js, and ipynb title-block author metadata. (author: @mcanouil for #14602)
 - ([#14604](https://github.com/quarto-dev/quarto-cli/issues/14604)): The `axe` accessibility report UI now shows each violation's WCAG conformance level (e.g. `WCAG 2.0 AA (1.4.3)`) or `Best Practice`, derived from the violation's axe-core tags.
+- ([#14607](https://github.com/quarto-dev/quarto-cli/issues/14607)): Add `standard` and `best-practice` options to `axe`. `standard` scopes accessibility checks to a WCAG conformance level (e.g. `standard: wcag21aa`), including the rules axe-core keeps off by default for that level (such as AAA color contrast); `best-practice` controls whether axe's best-practice rules (recommendations not required by any WCAG success criterion) are checked.
 - ([#14655](https://github.com/quarto-dev/quarto-cli/issues/14655)): Add accessible names to code line-number links so screen readers and accessibility audits no longer report them as empty links.
 - ([#14677](https://github.com/quarto-dev/quarto-cli/pull/14677)): The `axe` option now uses a copy of axe-core bundled with Quarto instead of loading it from the Skypack CDN in the reader's browser. Accessibility checking now works offline, and viewing a rendered document no longer triggers a request to `cdn.skypack.dev`. The axe-core version is unchanged (4.10.3), so scan results are identical.
 

src/resources/editor/tools/vs-code.mjs

@@ -21838,9 +21838,9 @@ var require_yaml_intelligence_resources = __commonJS({
           short: "Name that should be displayed for the overall site",
           long: "Name that should be displayed for the overall site. If not explicitly\nprovided in the <code>open-graph</code> metadata, Quarto will use the\nwebsite or book <code>title</code> by default."
         },
-        "Footer left content",
-        "Footer right content",
-        "Footer center content",
+        "Footer left content. Supports markdown formatting.",
+        "Footer right content. Supports markdown formatting.",
+        "Footer center content. Supports markdown formatting.",
         "Footer border (<code>true</code>, <code>false</code>, or a border\ncolor)",
         "Footer background color",
         "Footer foreground color",
@@ -21885,7 +21885,7 @@ var require_yaml_intelligence_resources = __commonJS({
         },
         "Path to a file containing the Plausible Analytics script snippet",
         "Provides an announcement displayed at the top of the page.",
-        "The content of the announcement",
+        "The content of the announcement. Supports markdown formatting.",
         "Whether this announcement may be dismissed by the user.",
         {
           short: "The icon to display in the announcement",
@@ -21943,7 +21943,7 @@ var require_yaml_intelligence_resources = __commonJS({
         "Field that contains the section of index entries",
         "Additional parameters to pass when executing a search",
         "Top navigation options",
-        "The navbar title. Uses the project title if none is specified.",
+        "The navbar title. Uses the project title if none is specified.\nSupports markdown formatting.",
         "Specification of image that will be displayed to the left of the\ntitle.",
         "Alternate text for the logo image.",
         "Target href from navbar logo / title. By default, the logo and title\nlink to the root page of the site (/index.html).",
@@ -21959,7 +21959,7 @@ var require_yaml_intelligence_resources = __commonJS({
         "Collapse tools into the navbar menu when the display becomes\nnarrow.",
         "Side navigation options",
         "The identifier for this sidebar.",
-        "The sidebar title. Uses the project title if none is specified.",
+        "The sidebar title. Uses the project title if none is specified.\nSupports markdown formatting.",
         "Specification of image that will be displayed in the sidebar.",
         "Alternate text for the logo image.",
         "Target href from navbar logo / title. By default, the logo and title\nlink to the root page of the site (/index.html).",
@@ -21976,7 +21976,7 @@ var require_yaml_intelligence_resources = __commonJS({
         "Markdown to place above sidebar content (text or file path)",
         "Markdown to place below sidebar content (text or file path)",
         "The identifier for this sidebar.",
-        "The sidebar title. Uses the project title if none is specified.",
+        "The sidebar title. Uses the project title if none is specified.\nSupports markdown formatting.",
         "Specification of image that will be displayed in the sidebar.",
         "Alternate text for the logo image.",
         "Target href from navbar logo / title. By default, the logo and title\nlink to the root page of the site (/index.html).",
@@ -22052,7 +22052,7 @@ var require_yaml_intelligence_resources = __commonJS({
         },
         "Path to a file containing the Plausible Analytics script snippet",
         "Provides an announcement displayed at the top of the page.",
-        "The content of the announcement",
+        "The content of the announcement. Supports markdown formatting.",
         "Whether this announcement may be dismissed by the user.",
         {
           short: "The icon to display in the announcement",
@@ -22110,7 +22110,7 @@ var require_yaml_intelligence_resources = __commonJS({
         "Field that contains the section of index entries",
         "Additional parameters to pass when executing a search",
         "Top navigation options",
-        "The navbar title. Uses the project title if none is specified.",
+        "The navbar title. Uses the project title if none is specified.\nSupports markdown formatting.",
         "Specification of image that will be displayed to the left of the\ntitle.",
         "Alternate text for the logo image.",
         "Target href from navbar logo / title. By default, the logo and title\nlink to the root page of the site (/index.html).",
@@ -22126,7 +22126,7 @@ var require_yaml_intelligence_resources = __commonJS({
         "Collapse tools into the navbar menu when the display becomes\nnarrow.",
         "Side navigation options",
         "The identifier for this sidebar.",
-        "The sidebar title. Uses the project title if none is specified.",
+        "The sidebar title. Uses the project title if none is specified.\nSupports markdown formatting.",
         "Specification of image that will be displayed in the sidebar.",
         "Alternate text for the logo image.",
         "Target href from navbar logo / title. By default, the logo and title\nlink to the root page of the site (/index.html).",
@@ -22143,7 +22143,7 @@ var require_yaml_intelligence_resources = __commonJS({
         "Markdown to place above sidebar content (text or file path)",
         "Markdown to place below sidebar content (text or file path)",
         "The identifier for this sidebar.",
-        "The sidebar title. Uses the project title if none is specified.",
+        "The sidebar title. Uses the project title if none is specified.\nSupports markdown formatting.",
         "Specification of image that will be displayed in the sidebar.",
         "Alternate text for the logo image.",
         "Target href from navbar logo / title. By default, the logo and title\nlink to the root page of the site (/index.html).",
@@ -24479,7 +24479,7 @@ var require_yaml_intelligence_resources = __commonJS({
         },
         "Path to a file containing the Plausible Analytics script snippet",
         "Provides an announcement displayed at the top of the page.",
-        "The content of the announcement",
+        "The content of the announcement. Supports markdown formatting.",
         "Whether this announcement may be dismissed by the user.",
         {
           short: "The icon to display in the announcement",
@@ -24537,7 +24537,7 @@ var require_yaml_intelligence_resources = __commonJS({
         "Field that contains the section of index entries",
         "Additional parameters to pass when executing a search",
         "Top navigation options",
-        "The navbar title. Uses the project title if none is specified.",
+        "The navbar title. Uses the project title if none is specified.\nSupports markdown formatting.",
         "Specification of image that will be displayed to the left of the\ntitle.",
         "Alternate text for the logo image.",
         "Target href from navbar logo / title. By default, the logo and title\nlink to the root page of the site (/index.html).",
@@ -24553,7 +24553,7 @@ var require_yaml_intelligence_resources = __commonJS({
         "Collapse tools into the navbar menu when the display becomes\nnarrow.",
         "Side navigation options",
         "The identifier for this sidebar.",
-        "The sidebar title. Uses the project title if none is specified.",
+        "The sidebar title. Uses the project title if none is specified.\nSupports markdown formatting.",
         "Specification of image that will be displayed in the sidebar.",
         "Alternate text for the logo image.",
         "Target href from navbar logo / title. By default, the logo and title\nlink to the root page of the site (/index.html).",
@@ -24570,7 +24570,7 @@ var require_yaml_intelligence_resources = __commonJS({
         "Markdown to place above sidebar content (text or file path)",
         "Markdown to place below sidebar content (text or file path)",
         "The identifier for this sidebar.",
-        "The sidebar title. Uses the project title if none is specified.",
+        "The sidebar title. Uses the project title if none is specified.\nSupports markdown formatting.",
         "Specification of image that will be displayed in the sidebar.",
         "Alternate text for the logo image.",
         "Target href from navbar logo / title. By default, the logo and title\nlink to the root page of the site (/index.html).",
@@ -24775,6 +24775,8 @@ var require_yaml_intelligence_resources = __commonJS({
         "List execution engines you want to give priority when determining\nwhich engine should render a notebook. If two engines have support for a\nnotebook, the one listed earlier will be chosen. Quarto\u2019s default order\nis \u2018knitr\u2019, \u2018jupyter\u2019, \u2018markdown\u2019, \u2018julia\u2019.",
         "When defined, run axe-core accessibility tests on the document.",
         "If set, output axe-core results on console. <code>json</code>:\nproduce structured output; <code>console</code>: print output to\njavascript console; <code>document</code>: produce a visual report of\nviolations in the document itself.",
+        "Only check the rules for this WCAG conformance level, named as\nversion then level (e.g.&nbsp;<code>wcag21aa</code> for WCAG 2.1 AA). Each\nlevel includes the levels and versions it builds on, and may check rules\naxe-core disables by default (such as AAA color contrast). Axe\u2019s\nbest-practice rules are excluded unless <code>best-practice: true</code>\nis also set.",
+        "Whether to check axe-core\u2019s best-practice rules (checks recommended\nby axe that aren\u2019t required by any WCAG success criterion). Checked by\ndefault when <code>standard</code> is unset; excluded by default when\n<code>standard</code> is set.",
         "The logo image.",
         {
           short: "Advanced geometry settings for Typst margin layout.",
@@ -24850,7 +24852,7 @@ var require_yaml_intelligence_resources = __commonJS({
         },
         "Path to a file containing the Plausible Analytics script snippet",
         "Provides an announcement displayed at the top of the page.",
-        "The content of the announcement",
+        "The content of the announcement. Supports markdown formatting.",
         "Whether this announcement may be dismissed by the user.",
         {
           short: "The icon to display in the announcement",
@@ -24908,7 +24910,7 @@ var require_yaml_intelligence_resources = __commonJS({
         "Field that contains the section of index entries",
         "Additional parameters to pass when executing a search",
         "Top navigation options",
-        "The navbar title. Uses the project title if none is specified.",
+        "The navbar title. Uses the project title if none is specified.\nSupports markdown formatting.",
         "Specification of image that will be displayed to the left of the\ntitle.",
         "Alternate text for the logo image.",
         "Target href from navbar logo / title. By default, the logo and title\nlink to the root page of the site (/index.html).",
@@ -24924,7 +24926,7 @@ var require_yaml_intelligence_resources = __commonJS({
         "Collapse tools into the navbar menu when the display becomes\nnarrow.",
         "Side navigation options",
         "The identifier for this sidebar.",
-        "The sidebar title. Uses the project title if none is specified.",
+        "The sidebar title. Uses the project title if none is specified.\nSupports markdown formatting.",
         "Specification of image that will be displayed in the sidebar.",
         "Alternate text for the logo image.",
         "Target href from navbar logo / title. By default, the logo and title\nlink to the root page of the site (/index.html).",
@@ -24941,7 +24943,7 @@ var require_yaml_intelligence_resources = __commonJS({
         "Markdown to place above sidebar content (text or file path)",
         "Markdown to place below sidebar content (text or file path)",
         "The identifier for this sidebar.",
-        "The sidebar title. Uses the project title if none is specified.",
+        "The sidebar title. Uses the project title if none is specified.\nSupports markdown formatting.",
         "Specification of image that will be displayed in the sidebar.",
         "Alternate text for the logo image.",
         "Target href from navbar logo / title. By default, the logo and title\nlink to the root page of the site (/index.html).",
@@ -25374,12 +25376,12 @@ var require_yaml_intelligence_resources = __commonJS({
         mermaid: "%%"
       },
       "handlers/mermaid/schema.yml": {
-        _internalId: 222617,
+        _internalId: 223022,
         type: "object",
         description: "be an object",
         properties: {
           "mermaid-format": {
-            _internalId: 222609,
+            _internalId: 223014,
             type: "enum",
             enum: [
               "png",
@@ -25395,7 +25397,7 @@ var require_yaml_intelligence_resources = __commonJS({
             exhaustiveCompletions: true
           },
           theme: {
-            _internalId: 222616,
+            _internalId: 223021,
             type: "anyOf",
             anyOf: [
               {
@@ -25457,6 +25459,25 @@ var require_yaml_intelligence_resources = __commonJS({
                         "document"
                       ],
                       description: "If set, output axe-core results on console. `json`: produce structured output; `console`: print output to javascript console; `document`: produce a visual report of violations in the document itself."
+                    },
+                    standard: {
+                      enum: [
+                        "wcag2a",
+                        "wcag2aa",
+                        "wcag2aaa",
+                        "wcag21a",
+                        "wcag21aa",
+                        "wcag21aaa",
+                        "wcag22a",
+                        "wcag22aa",
+                        "wcag22aaa"
+                      ],
+                      description: "Only check the rules for this WCAG conformance level, named as version then level (e.g. `wcag21aa` for WCAG 2.1 AA). Each level includes the levels and versions it builds on, and may check rules axe-core disables by default (such as AAA color contrast). Axe's best-practice rules are excluded unless `best-practice: true` is also set."
+                    },
+                    "best-practice": {
+                      boolean: {
+                        description: "Whether to check axe-core's best-practice rules (checks recommended by axe that aren't required by any WCAG success criterion). Checked by default when `standard` is unset; excluded by default when `standard` is set."
+                      }
                     }
                   }
                 }