JavaScript CSS HTML
Switch branches/tags
Nothing to show
Latest commit 1eb6e97 Aug 8, 2017 ZachSaucier Improved MathJax support

README.md

Just Read

I've started work on a paid version of Just Read. To find out more about it or to help contribute to what features should be included, please check out the GitHub issue.

The extension makes it easy to view web articles in a more readable, attractive, and custom format - like a read mode, but better. It removes the distractions like ads, modals, and navigation from vision, letting the user just read the content.

Please note: This extension is meant to format article-type pages only. It is not built to reformat other types of websites and is liable to not perform as one might expect.

How to install:

Install from Chrome's webstore:

  1. View it on the webstore and click "Add to Chrome".

Install from GitHub (for developers):

  1. Download the files (in zip form -> unzip OR git clone https://github.com/ZachSaucier/Just-Read.git).
  2. Open up your Chrome extensions page: chrome://extensions/
  3. Make sure the "Developer mode" checkbox is checked.
  4. Click "Load unpacked extension..." and select the folder that you downloaded Just Read to.
  5. Once that folder has been selected, Just Read should show up!

How to use:

Once Just Read has been installed, there are six built in ways to apply the effects to a given page. The first three use the default mechanism of selecting text and the other three allow the user to specify which text they want.

Note: Keyboard shortcuts may have to be enabled for them to work correctly. To do this, go to chrome://extensions/ and go to the very bottom. Click on "Keyboard shortcuts" and you can add/change shortcuts there.

Use Just Read's built in selection

You can start using Just Read's built in selection in four ways:

  1. Click the Just Read Chrome extension button. extension button

  2. Use the shortcut CTRL+SHIFT+L.

  3. Right click the current page and choose the "View this page using Just Read" option.

  4. Right click a link and select "View the linked page using Just Read" (it will open it in a new tab).

User selection mode

You can also select exactly the text you want to read if the built in method doesn't select what you want. If you want to use a visual selector, you can start selection mode in two ways:

  1. Right click the Just Read Chrome extension button, click "Select text to read", and then click the part of the page highlighted that you want to read.

  2. Use the shortcut CTRL+SHIFT+K then click the part of the page highlighted that you want to read.

Highlight mode

You can also select specific text by highlighting it (by clicking and dragging over the text), then right click it and select "View this text in Just Read".

Deletion mode

Once the text has been selected and the article is open in the Just Read format, users can delete elements by going into deletion mode using the keyboard shortcut CTRL+SHIFT+;. They can click on elements that they don't want to view (helpful for printing or if there are elements that aren't part of the article) and they will be deleted. To exit this mode, users need to press ESC.

You can also enable an icon to enter/exit deletion mode in Just Read's additional options which looks like this

Auto-enable Just Read on specific websites

You can also opt to auto-enable Just Read on certain websites by entering a part of the URL (usually the domain is a good choice) or a regular expression into the "Auto-run domain list" found on the extension's Options page (for more info as to what formats work, see this post. Just Read will then check each new site's URL to see if it matches the string or expression in the user-inputted list. If it does, it will start Just Read when the page loads. Auto-enable


Customization:

By default the extension will use a theme that we made as seen here the effect of the extension

You can customize this theme using the GUI shown when you click the paint brush icon. Just make sure to click "Save and close" when you're done or the styles will not be updated in the actual stylesheet. The GUI looks like this:

GUI

Note: The theme editor GUI will only appear for the default theme or themes derived from the default (that share "default-stylesheet" as part of the file name).

If you want to further customize the stylesheet or add and use your own, you can click the "openFullStyles" in the GUI or right click the extension button and open the "Options" page (you can also get to this via the Chrome extensions page). That will open a page that looks similar to this Options page

You can then select the file you want to edit or enter a new file name, edit the file, and then save or apply it. It will then apply to all of your Chrome tabs on any computer when you start the extension. You can rename files by double clicking the name of the file.

Additional options

If you click "Additional options" while on the options page, a new modal will show with the following options:

Additional options

"Show button for deletion mode" adds a new button when Just Read is open to start/stop deletion mode to prevent the need of the keyboard shortcut (but still retains keyboard shortcut functionality).

"Don't reformat pre tags" makes it so that Just Read doesn't turn any <pre> tags into paragraphs but retains their original formatting.

"Enable page context menu entry" allows Just Read to show a menu entry when you right click a page.

"Enable highlight context menu entry" allows Just Read to show a menu entry when you right click highlighted text.

"Enable link context menu entry" allows Just Read to show a menu entry when you right click a link.

Find themes or share your own

If you're looking to use other themes that people have built and use, you can check out this page. You can also share your own and "vote" using "Add your reaction"!


Privacy statement

Just Read collects absolutely zero personal data from users and sends nothing at all to any server, so you have no worry of any abuse from Just Read. All data Just Read uses is connected to your personal Google account on which you have installed Just Read and the creators of Just Read never see any of it.


Let me know how I can improve this extension including any bugs you see and what features you'd like to see!

This is a Chrome extension was initially made in 16 hours at UGA Hacks Fall 2015 and has been updated since.


Donate

I created and maintain this extension for no pay and will always keep Just Read free. If you want to be generous and show appreciation for the product I've created, you can donate to help me take my girlfriend out for a nice dinner via the PayPal donate link below.

paypal

Follow me: Twitter, CodePen, GitHub