Skip to content

w3c/wai-aria-practices

Repository files navigation

WAI-ARIA Authoring Practices

This repository contains the source code for the ARIA Authoring Practices Guide which is hosted as part of 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.

More details on how the workflows between the aria-practices and this repository communicate is described in the wiki.

Local development

  • Ensure Ruby and Node (v14 or greater) are installed.
  • Clone this repo: git clone git@github.com:w3c/wai-aria-practices.git
  • Initialize or update submodules: git submodule update --init --recursive
  • Install Jekyll: bundle install.
  • 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/WAI/ARIA/apg/

Netlify CD status

Netlify Status