Skip to content

A plugin to check your post content for common accessibility pitfalls.

Notifications You must be signed in to change notification settings

ryanAllMad/a11y-checker

Repository files navigation

A11y Check

A11y Check will help you check your posts for common accessibility pitfalls.

Description

A11y Check will check your content for issues with WCAG(Web Content Accessibility Guidelines). A11y Check also instructs you on which WCA Guidelines to watch out for and how to pass them. Below shows how this plugin works.

Images

This video shows a post with 2 images that are missing alternative text. The "Images Without Text Alternative" section shows a list of image files without a text alternative. The mouse adds alt text to one of the images, and it is removed from the list. There is a checkbox next to each image file to choose if the image is decorative. The mouse in the video below marks one of the images as decorative.

images-check

Headings

This video shows a post with headings that are not descriptive and out of order. In the "Headings are descriptive and in order" section, the mouse clicks the "Show headings" button under the heading "we found headings on the page". When "Show headings" is clicked, the heading blocks in the post editor will be outlined. Next the mouse scrolls down and clicks the "Open Document Outlin" button under the "Headings are out of order" heading.

headings-check

Links

In this last video, under the "Links are descriptive and not redundant" heading, the user can click "Show links" to highlight the links on the page and determine if the link text is descriptive. Once they're done they can mark the checkbox.

links-check

Installation

This section describes how to install the plugin and get it working.

e.g.

  1. Upload a11y-check.zip to the /wp-content/plugins/ directory
  2. Unzip folder.
  3. Activate the plugin through the 'Plugins' menu in WordPress

Changelog

0.1.0

  • A11y Check created.

About

A plugin to check your post content for common accessibility pitfalls.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published