Code Monkey home page Code Monkey logo

unclutter's Introduction

Unclutter โ€” Modern Reader Mode

Unclutter is a modern reader mode and article library for your browser.

Latest release GitHub commits Chrome users Firefox users Chrome Ratings

Why does it exist?

There many other "reader modes", but they all extract article text and re-render it their own format. Unclutter "unclutters" the original web pages itself, leaving their visual style and interactive elements intact.

Articles you read with Unclutter are automatically saved and can be easily added to your read-it-later queue. Everything happens instantly in your browser.

Other features include:

Try it out for yourself:

Get involved

The mission of Unclutter is to improve reading on the web. You should decide what, when, and how to read.

Join our Discord server to help out and follow the progress!

Here's how you can contribute:

Documentation

See the docs pages, or the technical README. Please open an issue for any question you have!

Licence

This project uses GNU AGPLv3, which requires commercial projects that use it to be open-source as well.

Unclutter exists thanks to everyone who contributes ideas or code, reports bugs, or simply uses the extension. Thank you!

unclutter's People

Contributors

jessmartin avatar lindy-bot avatar phgn0 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

unclutter's Issues

Unclutter breaks Chrome's PDF viewer

Description

When trying to view an online PDF in Chrome, Unclutter displays an error message ("page broken") and the PDF doesn't load. If I toggle the unclutter switch on the top right, the PDF remains hidden under an empty page or is just barely visible on the top (just a few pixels of the PDF can be seen).

A solution

Do not unclutter any page that ends with .pdf or contains Chrome's PDF viewer (note: some pages embed the viewer, so that has to be taken into account too).

Example websites

Literally any online PDF

Tested on

Chrome OS with Chrome 99

Broken website styling: undefined

A user reported an issue on https://undefined from within the extension.

        URL: undefined
        
        Unclutter version: `0.15.5`
        Browser: `chromium`
        User Agent: `Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.5005.115 Safari/537.36`

Add initial installation guide

Many of the extension's functions are not explained explicitly, which is frustrating when it does things that are non-obvious. An example is the automatic activation on websites you once activated the extension manually.

We should have a web page that opens on installation of the extension that explains the basic concepts.

No way to turn off annotations

Means I can't use other extensions within the article (e.g., search for a movie whose title is mentioned in the article)

Broken website styling: undefined

A user reported an issue on undefined from within the extension.

Unclutter version: 0.15.5
Browser type: chromium
User Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.5005.115 Safari/537.36

hypothes.is title

Greetings! I was test-driving the plugin (Chrome - 0.13.7) with hypothes.is sync enabled, and while the annotations are syncing, they are all listed in hypothes.is as being "untitled article," for example:

CleanShot 2022-05-13 at 12 27 37

Add contribution guide

Add a readme file explaining the current code structure and good parts to contribute to.

Unable to turn off unclutter

With the latest version (0.13.4) I am no longer able to restore an "uncluttered" page to its original appearance via the toolbar icon

Broken website styling: undefined

A user reported an issue on https://undefined from within the extension.

URL: undefined
Unclutter version: 0.15.5
Browser: chromium
User Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.5005.115 Safari/537.36

Enabling the extension breaks xkcd's layout on Firefox

What the title says. Just having the extension enabled on Firefox breaks the layout of xkcd. Doesn't seem to happen on Chrome, however.

With the extension enabled:
Screen Shot 2022-06-06 at 10 36 46-fullpage

Without it enabled:
Screen Shot 2022-06-06 at 10 37 57-fullpage

  • Unclutter 0.15.2
  • Firefox 101.0 on macOS 12.4

Improve activation animation

Uncluttering a page often creates many DOM changes as new styles are applied, elements are removed, text sizes are changed, margins reduced etc. This looks jittery.

Let's look into more pleasing animations for removed elements.

Print style

The uncluttered article should look nice when printing the webpage.

Reported on Twitter.

Enabling this extension on my blog breaks the sub-heading detection and thus the TOC

Hello,

I have started using your Unclutter extension on Firefox (v101.0) and it's working really well on the few websites I tried it on.

But when I tried it on my blog, I saw it fail: https://scripter.co/zero-html-validation-errors/

Here is what I expected Unclutter's TOC to show but on the left side:

image

But when I run Unclutter, it seems to mis-parse in between headings:

image

You can see that it's missing these headings:

  • 3. Ensure that all images ..
  • Validation Ignores
  • Summary

Also, once I disable Unclutter, that same page shows like this (it's missing the TOC that I had earlier on the right side, also the CSS in the header, around the pre blocks, etc. looks off):

image

Running Ctrl + F5 fixes those CSS problems.

Please let me know if this is something that can be fixed on Unclutter side or it's my mistake.

Thanks!

Cannot access extension setting page

The extension's setting page in Firefox Dev Edition.
It briefly shows a "File not found" error and scroll down to oblivion.

Firefox version: Mozilla/5.0 (X11; Linux x86_64; rv:99.0) Gecko/20100101 Firefox/99.0
Platform: Linux 5.13.0-35-generic #40-Ubuntu SMP Mon Mar 7 08:03:10 UTC 2022
Screenshot from 2022-03-19 18-16-51

Original style broken after disabling Unclutter

After disabling Unclutter via the extension icon, the original site often looks broken. (not all style is removed properly)

Multiple users have reported finding this annoying, so we should address this.

Font size normalisation issues

Icon elsewhere than on article disables unclutter

Hi, great extension, no issue, unless a slight bother with an uncluttered page : wherever I click on the page behind the article the article returns to normal display; I'd appreciate that this happen only with the toolbar action button which triggers unclutter on/off. If the user inadvertently clicks out of the article the uncluttering is disabled, quite bothering.

Otherwise, no issue, brilliant.

Broken website styling: undefined

A user reported an issue on https://undefined from within the extension.

        URL: undefined
        
        Unclutter version: `0.15.5`
        Browser: `chromium`
        User Agent: `Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.5005.115 Safari/537.36`

Broken website styling: example.com

A user reported an issue on example.com from within the extension.

URL: https://example.com/1

Unclutter version: 0.15.5
Browser: Chrome
User Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/102.0.5005.115 Safari/537.36

Support regex list of URLs where to enable the extension

Right now the extension only considers specific domains allowlisted or blocklisted manually, or a list of default disabled domains in defaultStorage.js.

To reduce the number of activations on non-article URLs, a more specific list of regex filters would be interesting. This list could even be crowdsourced.

See

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.