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.
This assumes you are using a Google Chrome browser.
- Download this repo as a
ZIPfile. - Navigate to
chrome://extensions/. - Select
Load unpacked. - Choose this unzipped repo folder.
- Navigate to github.com.
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. 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.
- 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.
Note: This is currently not customizable and 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 to your preferred styling. Then press Update on chrome://extensions/ so changes are reflected in extension.
If you encounter a bug, please file a ticket. Contributions welcome.