06b / a11y-checker

Identifies accessibility issues in HTML markup.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

a11y checker

Identifies accessibility issues in HTML markup.

Install

npm install --save a11y-checker

Usage

  • Import a11yChecker
import a11yChecker from 'a11y-checker';
  • Call it after page loads:
a11yChecker();

Live Examples

Contributing

Hey there! Thanks for your interest in helping out. If you happen to run into any issues, please open an issue, and I'll do my best to help out.

To begin contributing, you'll first need to clone this repository, then navigate into the repository's directory.

git clone git@github.com:{{ YOUR_USERNAME }}/a11y-checker.git

cd a11y-checker/

Next, install the dependencies using npm.

npm install

Great! – you're ready to contribute!

Just create your git branch and run code locally. To do that, execute the start command:

commands Description
npm start Run project locally on port=8080.
npm build Generate a minified, production-ready build.

Files structure

Folder Description
src for development files.
head for check everything happens inside <head>
body for check everything happens inside <body>

Rules

Docs

That's All. Thanks.

About

Identifies accessibility issues in HTML markup.

License:MIT License


Languages

Language:JavaScript 94.9%Language:HTML 5.1%