Readeck Browser Extension

License: GPL v3 Download For Firefox Download For Chrome

Readeck is a simple web application that lets you save the precious readable content of web pages you like and want to keep forever.
See it as a bookmark manager and a read later tool.

More information on https://codeberg.org/readeck/readeck

This is the browser extension that lets you save pages directly from your browser.

Features

Send the content as you see it

Sometimes, Readeck can't directly save an article. There can be many reasons for that; the service is blocked by a website or it's a subscription only website.

The extension solves these issues by sending the full content of the page you want to save, including images.

Select content

In other occasions, you might need to save only a specific part of a page. If you select some text and click on the Readeck button, only the selected part will be sent to Readeck.
You can even save multiple selections at once!

Installation

Firefox

You can install the Readeck Extension from the Mozilla Addon Repository.

Chrome, Chromium

You can install the Readeck Extention from the Chrome Web Store.

Development

After checking out the repository, you need to download all dependencies:

npm ci

Then you can run the extension in either Firefox or Chrome depending on your preference:

make moz-run

make chrome-run

Safari on macOS

There exists a Makefile target for building the sources for the Safari web extension, but additional steps are required to load the extension in Safari.

make safari-build
#=> Writes to the "addon/" directory

After that, in Safari Settings' "Developer" tab you need to:

1. Check "Allow unsigned extensions";
2. Click "Add Temporary Extension..." and load the generated addon/ directory.

A temporary extension will remain loaded in Safari for up to 24 hours or until Safari exits.

After changes to the source code of the web extension, you will need to manually reload the extension for those changes to take effect:

1. make safari-build;
2. Safari Settings → Extensions → Readeck → "Reload".

JavaScript log messages and error stack traces originating from the web extension can be found in different places:

• content-script.js messagess will be in the main JS console of the web page where the web extension was activated.
• background.js messages can be viewed by first clicking the Readeck toolbar icon to open the extension popup, then going to Safari → Develop → "Web Extension Background Content" → Readeck.
• Messages from the page within the popup itself can be viewed by right-clicking within the popup, choosing "Inspect Element", then switching the opened window to the "Console" tab.

Testing the Safari web extension native build

Safari extensions are ultimately distributed as native apps built with Xcode. For that, Apple provides a web extension converter tool, which can be activated by:

make safari-convert

After Xcode opens, select the "macOS" target and run the project by clicking the "▶" icon. As soon as the Readeck application runs, it will be available as a Safari extension.

Note that if you do _not+ have an Apple Developer license, the native build will be unsigned and the only way of loading it would be to first check the "Allow unsigned extensions" option in Safari.