Creating a PR: Building and previewing documents

Document build

You can build the understanding and technique documents locally.

The main spec is done separately (with Respec), this is only for the informative docs.

Eleventy Process (introduced July 2024)

See https://github.com/w3c/wcag/tree/main/11ty#usage for full instructions on installation and previewing locally.

The short version:

1. Install Node.js (preferably v20, the current LTS)
2. Run npm i in the root of the repository
3. Run npm start for a local development server, or npm run build to generate all files under _site

Ant Process (removed)

As of August 2024, the Ant/XSLT process for building informative documentation has been removed, as there are now features taking advantage of Eleventy that are no longer backwards-compatible.

Online Previews of Informative Docs

Pull requests now include automatic Netlify previews with a top-level index page! You will need to navigate through /techniques/ or /understanding/ as appropriate.

GitHack Preview

If you have an html file in branch that displays as code (and the automatic Netlify preview is not available), one can use https://raw.githack.com to present a (partially) rendered version. You will need the branch, path, and filename. The URL you paste into GitHack will something look like https://github.com/w3c/wcag/blob/MyCoolBranch/techniques/general/G123.html and the resultant URL will be something like https://raw.githack.com/w3c/wcag/MyCoolBranch/techniques/general/G123.html