A11Y Project
Making #A11Y tips and tricks easier to digest and leveraging the community into the cloud. The Accessibility Project is a community–driven effort to make web accessibility easier.
This site is the product of a community of people who want to help to make web accessibility…well, accessible. Our goal is to accomplish this with 3 tennets in mind:
- Digestible. Articles on accessibilty tend to be in-depth. We feature short, digestible pieces of content.
- Up-to-date. The project is hosted on Github so information can be current with the latest standards.
- Forgiving. People make mistakes and web accessiblity is hard, so we seek to be encouraging.
##Contributing
Everything you need to know about contributing to this project can be found in our Contributor Docs
##Requirements
In order to contribute to the website’s codebase, you’ll need to know a bit about Jekyll, Compass, Sass, Bootstrap, Bash and Markdown. You'll also need to know how to install Ruby Gems and of course have Ruby installed on your machine.
###Gem Installation
Use the bundle
command to install the necessary gems for the A11Y Project. (Hint: All the cool kids use ruby version manager to organize gemset
dependencies):
If you don't have bundler installed you'll need to run gem install bundler
before using bundle
.
$ bundle
##Under the Hood
###Markup Posts are all written in Markdown.
###Stylesheets Authored with Compass and Sass.
###Framework The site is built on a customized Compass port of Bootstrap. Jekyll is used for templating and posts.
##Local Development
The following are tasks which can be run from your shell of choice. Some of us use iTerm for Mac but whatevs.
###Rake Commands
The following rake
tasks are available and are used for testing the site locally, on your own machine (use rake -T
to list them):
rake build # Build site with Jekyll
rake check_links # Check links for site already running on localhost:4000
rake clean # Clean up generated site
rake server # Start the server
rake check # Check if site will run on Github pages
Local Server
Trigger the local server by executing the rake server
task. Your local copy will now be accessible at http://localhost:4000
.