Skip to content

javoire/dyslexia-friendly

Repository files navigation

DyslexiaFriendly

Description

DyslexiaFriendly is a Google Chrome extension that increases readabilty of web pages by allowing you to switch to a dyslexia friendlier font and providing some extra tools to facilitate the reading.

Features

You can change the font on all web sites to either Open Dyslexic or Comic Sans. The visual appearance of all web sites is also enhanced with odd/even background shading of paragraphs and a vertical ruler that follows the mouse cursor.

The features listed here are also implemented: http://antijingoist.github.io/web-accessibility/

Develop

Popup only

Run the devserver. However, any messages to background or content scripts will not be sent (as those scripts don't exist in this mode). The devserver is useful for tweaking layout and styling of the popup.

$ yarn start

Full extension

Do once:

  1. Run yarn build
  2. Navigate to chrome://extensions in Chrome
  3. Enable "Developer mode",
  4. Click "Load unpacked extension" and select the build/ folder

Do on changes to source files:

  1. Run yarn build
  2. Navigate to chrome://extensions in Chrome
  3. Click the reload button on the extension card (circular arrow icon)

Publish

The CI pipeline triggers publish on new git tags.

After a PR is merged to master:

  1. Update the version number in src/manifest.json on master
  2. Create a new git tag for that version and the publish pipeline will be triggered

Design

CSS and UI elements are from https://tailwind-elements.com/

Roadmap

Further customization of fonts and colors

Attributions

This extension is based on resources and ideas from: