The Pa11y website, pa11y.org is built with Jekyll and hosted on GitHub Pages.
This project uses Ruby, its packaging helper Bundler, and Node.js.
Here's one way to install each of these if you don't have them already. This assumes you're using macOS or Linux, with Homebrew or Linuxbrew installed. It will install nvm, chruby, and ruby-install.
# Install Ruby and Bundler
brew install ruby-install chruby
ruby-install "$(cat .ruby-version)"
gem install bundler
# Install Node and update npm
brew install nvm
nvm install
nvm install-latest-npmmake install
make serve
open http://localhost:4000The home page text content can be found in pages/home.md.
The news feed content can be found in the _posts folder. It's best to copy an existing item and change the date/title.
It's important to note that the date appears in both the file name and the date front-matter property.
You may add authorship details to a post using the author.name and author.url front-matter properties. Both are optional. The rule of thumb is that generic posts (like version releases/launches etc) should have no author, but more opinion or analysis posts should.
The tutorials page text content can be found in pages/tutorials.md. The actual tutorial information is in _data/tutorials.yml; there are instructions at the top of this file.
The contributor guides live in the contributing folder as Markdown files. Edit the others at will, but the Code of Conduct should not be edited – we use the Contributor Covenant without modifications.
The contact page text content can be found in pages/contact.md. To add your contact details to this page, edit _data/team.yml; there are instructions at the top of this file.
Every page on this site is tested in CI using Pa11y. Pull requests will fail the build if they introduce accessibility errors. You can run Pa11y against a site that's running locally with:
make test
Licensed under the Creative Commons Attribution-NonCommercial 4.0 International License.
Copyright © 2016–2023, Team Pa11y
