/tranquility-reader-webextensions

Tranquility Reader rewritten using Webextensions API

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

Tranquility Reader

Tranquility Reader is a Firefox extension that improves the readability of web articles.

Tranquility removes unnecessary elements in a webpage, and provides a simple and tranquil reading experience. Similar functionality is available through Readability or iReader or "Reader Mode" in Firefox. Please try the built in "Reader Mode" first and then consider Tranquility Reader only if some of the features available only in Tranquility Reader are critical for you.

To use tranquility you can:

  • Click on the navigation-bar icon to transform the page in the Desktop Version
  • Select the "Tranquility!" menu option from the toolbar menu on Android

Features:

  • Compatible with NoScript

  • Save content offline for reading later. The tranquility view is saved locally on your computer

  • Ability to export/import the offline content.

  • Ability to customize default font, font-size, font color, background color, and width of the reading area (you can use this website to pick a suitable color code - thanks to user JA for feedback on this)

  • Create and manage your own preset configuration of the various options/preferences

  • Add/edit notes/annotations to portions of the offline content; collate annotations with context for a summary of all your notes and annotations.

  • Unobtrusive Menu at the bottom of the screen (displayed on clicking on the (+) symbol on the bottom right corner of the screen) provides additional features

  • Additional links are now available through a "More Links" button in the Menu at the bottom of the screen

  • Left clicking on a link in the Tranquility view will also open the link URL in the Tranquility view in the current tab

  • Firefox for AndroidOS is supported from version 3.0.5 - please check the release notes for this version for limitations on AndroidOS.

  • Transform only a portion of the webpage by highlighting the text and then running Tranquility (right click context menu option - "Tranquilize Selection". Available from 3.0.7; not supported on AndroidOS.)

User Guide:

Refer to this wiki page for a detailed tour of the Tranquility Reader extension, its various features and how to make the most of the extension.

License & Copyright:

Tranquility is provided under GPLv3 license. Copyright (C) 2012-2024 Arun Kunchithapatham

Privacy Policy:

This addon does not collect or transmit any information to an external website. All processing and data storage is local to your browser. For more details, see the PRIVACY.md file.

Feedback:

Please use Github to send any feedback, bug reports, enhancement requests.

Release notes:

Please check the RELEASE-NOTES.md file for detailed release notes.