Thanks to visit codestin.com
Credit goes to github.com

Skip to content

khiga8/github-a11y

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

github-a11y

This is a Google Chrome extension that runs a simple JavaScript snippet on github.com domain and aims to encourage accessibility mindfulness while navigating GitHub. Users interact with GitHub predominantly through the markdown editor. The markdown editor allows users to set headings and share images, both of which require care to ensure accessibility.

Prerequisite

This assumes you are using a Google Chrome browser.

Setup

  1. Download this repo as a ZIP file.
  2. Navigate to chrome://extensions/.
  3. Select Load unpacked.
  4. Choose this unzipped repo folder.
  5. Navigate to github.com.

Features

This extension will only run on GitHub domain and does the folowing on all markdown bodies on GitHub:

  • Creates a text overlay over all images with the alt text. This includes Pull Requests, Issues, Repo READMEs, and Discussions. If an image is missing an alt text, it will appear with a red border. If an image has an empty alt text, the text will show with italicized caption, "hidden". Images are frequently shared within GitHub. This image overlay aims to bring awareness about alt text particularly for sighted users who may not rely on alt text.

Example screenshots of images that have been posted on a GitHub issue. The extension has added a white text containing alt text against dark image overlay.

  • Appends the heading level that is used after the heading text within markdown bodies. Heading levels are useful for conveying semantics for screen reader, and other assistive technology users. This similarly aims to bring mindfulness particularly for sighted users who may pay less attention to heading level semantics.

Example screenshots of purple heading levels appended in at end of heading text line inside a GitHub markdown

Customization note

The styling I've set may not be suitable for all users. Feel free to customize this however you like when you download these files.

You can do this by modifying styles.css. There are CSS variables at the top which you may set to your preferred colors. For example, you may choose to set a different color for each heading level, or add a border for distinguishability. If you'd prefer the headings to be positioned at front, follow the notes in contentScript.js. Once changes are made, Update on chrome://extensions/ so changes are reflected in extension.

Resources

Image alt text

Heading levels

Bug?

If you encounter a bug, please file a ticket. Contributions welcome.

About

Browser extension that encourages accessibility awareness while using GitHub

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 8