benbalter/ra11y

Ruby-based automated accessibility testing

Ra11y

Ruby-based automated accessibility testing for Jekyll and other static sites

Requirements

Ra11y requires Pa11y or a similar command-line accessibility testing tool. To install Pa11y:

npm install -g pa11y

Installation

Add this line to your application's Gemfile:

gem 'ra11y'

And then execute:

$ bundle

Usage with Jekyll

Add the following to a Rakefile:

require 'ra11y'

task :test do
  sh "bundle exec jekyll build"
  Ra11y::Site.new("./_site").run
end

Then run bundle exec rake test

Contributing

1. Fork it ( https://github.com/[my-github-username]/ra11y/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request