cehfisher / a11y-style-guide

Accessibility (A11Y) Style Guide
http://a11y-style-guide.com/style-guide
MIT License
558 stars 61 forks source link
a11y a11y-experiment accessibility accessible-pieces kss-node pattern-library patterns sass style-guide styleguide twig twig-templates

A11Y Style Guide

This application is a living style guide or pattern library, generated from KSS documented styles...with an accessibility twist. No matter your level of development or accessibility expertise, there are ways to help contribute to the a11y style guide.

See a live demo of the style guide.

Why did this project start?

We wear a lot of hats as front-end developers. Depending on the client or company you work for, you may be the designer, UX/UI specialist, site-builder, QA tester, and developer all rolled into one. How can we possibly add the accessibility hat on top of all that? What accessible pieces should we even include? Which pieces are easy wins vs. impossible juggernauts? How do we implement inclusive design and development when a project does not have a lot of time or budget to include that piece?

One way we can tackle these issues is by using an accessible component driven approach. By thinking about inclusiveness from the start, we can get a head start on accessibility while still building the required site components.

The A11Y style guide comes with pre-populated accessible components that include helpful links to related tools, articles, and WCAG guidelines to make your site more inclusive. These components also serve as a guide for both HTML markup and SCSS/CSS code, to inform designers, front-end and back-end developers at every stage of the website’s creation.

How do you use this tool?

  • As a reference.
  • As a base for your own style guide.
  • As a base for creating your own accessible components.
  • As a base for a new accessible theme.
  • Contribute to the style guide and make it better.

Really? What can't you do with it is an easier question?

How can you contribute?

Please see the Contributing Guide for more information.

How did you get here?

Maybe you are a total beginner and wondering where to start? That's cool...welcome! Learning accessibility can feel a bit like drinking out of a firehose, so here are some tips to follow on your journey toward accessibility: Getting Started with Website Accessibility or check out the Resources page. For more information on my past articles, conference talks, or to see some accessible SVGs in action, check out my personal website cariefisher.com

Thanks!