Read.LKL (v 0.3.0)

Read.LKL (reads: read local) is an attempt to build a simple reader (with web-annotation) for HTML documents.

The main values are:

• local first:
• simplified text layout:
• web standards:

TEST IT

DEMO server coming soon!!!

Road Map and Functionalities

The simplest version possible is now implemented: you just need to load the main page reader.html from an HTTP server configure to serve the static folder as /.

By adding ?READ=<URL> to this reader page, (where <URL> is the public web page you want to read), the reader will load, simplify, and show it with annotations enabled. Just select text to highlight!

Reading Mode

I LOVE the reading experience where popular browsers simplify the page, removing all the bloat content (like ads, menus, colors, etc.)

• We are simplifying the loaded page with mozilla/Readability.
• TODO: Maybe we need a configuration to say we need the full page?

Web annotation

Who doesn't like to read highlighting stuff?

I am using the annotation web standard as implemented by apache/annotator.

• Implemented the "annotate-lkl" module based on the Get Started code!
• This only adds a yellow highlight and changes to orange when clicked.
• TODO: Improve annotation tools:
  • add color buttons
  • add remove highlight
  • add note

Save HTML page

• TODO: Ability to save annotations in the document and load the page (TOTALLY LKL!)

Save web annotation separately

• TODO

HOW TO RUN IT?

This should be as easy to run as loading the reader.html into your browser. BUT life is not that easy: when you'd try to load an external page through your "local" reader, most HTTP servers will not let you to process their content via code (i.e., CORS stuff.).

Hence, we could run this right now in two ways:

1. either you use a proxy server that will download the content to you (which we implement in the current reader);
2. (DOUBLE CHECK) or you download the page you want to read and serve it locally
3. (IDEA) can one load the content from another TAB in the same browser session? (likely the best as this would inherit all browser permission, in case of paywall.)

NODE

Just runs an HTTP server with express:

npm install node index.js

PYTHON

Just run a simple HTTP server with python: DO NOT use in production

cd static python -m http.server