isabella232 / wai-aria-practices

WAI Website Resource for aria-practices guidelines

WAI-ARIA Authoring Practices

This repository prepares the ARIA Authoring Practices Guide for integration into the Web Accessibility Initiative website.

The WAI website is built in Jekyll and brings together several git submodules into one website.

This project implements a pipeline to convert the aria-practices repository (which is currently a single static HTML file served by gh-pages which has been formatted and post-processed with ReSpec) into a multi-page static website to be served as a standalone resource on the wai-website.

Local development

• Ensure Ruby and Node (v14 or greater) are installed.
• Clone this repo: git clone [email protected]:w3c/wai-aria-practices.git
• Initialize or update submodules: git submodule update --init --recursive
• Install Jekyll: bundle install.
• Install ReSpec: npm install --global respec
• Run ReSpec: respec2html --src ./_external/aria-practices/aria-practices.html --out ./_includes/aria-practices.html
• Install npm dependencies: npm install -C scripts/pre-build
• Run the pre-build script: node ./scripts/pre-build
• Run Jekyll: bundle exec jekyll serve -w --livereload. (-w --livereload doesn't work on native Windows, OK in WSL)
• View the webpage at http://localhost:4000/

Next steps

• Move repo to W3C organization.
• Integrate with Netlify CI/CD.
• Integrate this resource with the main WAI website.

Netlify CD status

Click to explore