Code Monkey home page Code Monkey logo

a11y.css's Introduction

a11y.css

Pronounced « Alix ». Because it's fun.

GitHub version npm version Bower version devDependency Status Build Status Code Climate

Introduction

This CSS file intends to warn developers about possible risks and mistakes that exist in HTML code. It can also be used to roughly evaluate a site's quality by simply including it as an external stylesheet.

When hovering marked elements, a little banner should appear on top of your browser displaying what's going on.

This file is not a replacement to a complete tool such as OpQuast Reporting. It only intends to show possible weaknesses. You should obviously do some manual check by hand to know whether the code should or should not be fixed.

Usage

You can use a11y.css in multiple ways.

Bookmarklet

You can easily use the latest version of this stylesheet by adding this bookmarklet to your bookmarks:

javascript:(function(){a11ycss=document.createElement('LINK');a11ycss.href='https://rawgit.com/ffoodd/a11y.css/master/css/a11y-en.css';a11ycss.rel='stylesheet';a11ycss.media='all';document.body.appendChild(a11ycss);})();

You can also generate your own bookmarklet (choosing language and minimum level) on the dedicated page then directly drag it to your bookmarks. Isn't it handy?

Counters

CSS counters are incremented on each error/advice/warning and results are displayed with html::after. Since it is added through CSS, it is basically fake-content which is good since it is no more than visual indication for the developper to see what's going on. It will appear on the bottom left side of your page :).

CSS file

You will find static CSS files in the /CSS folder. CSS files are available in french and english, and leveled or full. You can simply download it and add it to your usual stack, just like any CSS.

Sass files

You can play with sources and easily build your own version of a11y.css.

Gulp file

If you're brave enough, the gulpfile.js allows you to work with every brick of this project:

  • Sass linting and compilation;
  • CSS linting and optimization (for readability);
  • Hologram and SassDoc generation.

I guess you will find your way out of this configuration file, but if not: ask me! Notice: you'll need a few Ruby gem, Ì suggest Bundler and bundle install.

Via npm or Bower

You can get this project by running npm install a11y.css or bower install a11y.css.

Credits and Acknowledgements

Acknowledgements

Many references helped me in the making of this stylesheet:

Although let's keep in mind the idea has nothing new (there is an article from Marco Battilana from 2006, and a proposal by Eric Meyer himself from 2007). I only tried to push things further. I suggest you read my article (in French) to learn more about the project.

Contributors

They helped a lot:

And they took time to open a few issues:

Thank you all!

This project is distributed under MIT license and CC BY 3.0 FR. Copyright (c) 2013 Gaël Poupard

a11y.css's People

Contributors

ffoodd avatar kittygiraudel avatar a5e avatar gaetanbt avatar bartveneman avatar aidanthreadgold avatar nico3333fr avatar

Watchers

James Cloos avatar Fabrice Gangler avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.