From 6faf0e2e172896201c578cf12627b54982a584cf Mon Sep 17 00:00:00 2001 From: JC Date: Tue, 11 Jun 2024 04:28:46 +0800 Subject: [PATCH] Add acknowledgement section --- README.md | 40 ++++++++++++++++++++++++++++++++++------ 1 file changed, 34 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e72bb40..47e5a93 100644 --- a/README.md +++ b/README.md @@ -411,14 +411,36 @@ These base configurations provide a foundation for enforcing consistent styles a WDS BT is equipped with automated workflow actions that ensure code security and uphold code quality standards with every commit. Accessibility check has been integrated into the development process, guaranteeing that websites built with WDS BT prioritize accessibility compliance based on WCAG 2.2 standards. This proactive approach underscores WDS BT's commitment to providing an inclusive user experience for all.
-A11y script (npm run a11y) +A11y Test (npm run a11y) - **Purpose**: To guarantee that the theme meets the Web Content Accessibility Guidelines (WCAG) standards. -- **Configuration**: Accessibility checks are integrated into the development process using `pa11y-ci` by running `npm run a11y`. -- **Local Configuration**: - - The `a11y.cjs` script prompts the developer to input a URL for testing accessibility. - - If no URL is provided, it defaults to https://wdsbt.local. - - The script runs pa11y-ci on the specified URL to perform the accessibility audit. +- **Running the A11y Test Script**: + - Accessibility checks are integrated into the development process using `pa11y-ci` by running: + ```bash + npm run a11y + ``` + - You will be prompted to enter the URL of the site you want to test for accessibility. If you leave it blank, it will default to https://wdsbt.local. +- **Script Details**: + The script performs the following actions + - **Prompts for URL**: You will be prompted to enter the URL of the site you want to test for accessibility. If you leave it blank, it will default to https://wdsbt.local. + - **Checks for Sitemap**: Attempts to access the sitemap at `[URL]/wp-sitemap.xml`. + - **Runs Accessibility Tests**: + - If the sitemap is found, the script runs `pa11y-ci` on the sitemap URL. + ```bash + $ npm run a11y + Please enter the URL to test for accessibility (leave blank to use your local: https://wdsbt.local): + > https://example.com + Sitemap found at https://example.com/wp-sitemap.xml. Running pa11y-ci on the sitemap... + [output from pa11y-ci] + ``` + - If the sitemap is not found, the script runs pa11y-ci on the main page URL. + ```bash + $ npm run a11y + Please enter the URL to test for accessibility (leave blank to use your local: https://wdsbt.local): + > https://example.com + No sitemap found at https://example.com/wp-sitemap.xml. Running pa11y-ci on the main page... + [output from pa11y-ci] + ``` - **Violation Reports**: Any detected accessibility violations are displayed in the console for immediate review and action.
@@ -473,4 +495,10 @@ WDS BT is free software, and is released under the terms of the GNU General Publ *** +## Acknowledgement + +While the WDS-BT theme has evolved significantly, it was initially inspired by the [Powder](https://github.com/bgardner/powder) theme. We acknowledge and thank the creators of Powder for their work. + +*** + [🔝 Back to Top](#wds-bt)