khanhas / hackernews2remarkable

Fetch top articles from HackerNews, pack as EPUB right in your reMarkable device

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

hackernews2remarkable

Fetch top articles from HackerNews, pack as EPUB right in your reMarkable device

Requirements

NOTE: This project is meant to run on reMarkable device, not your PC machine. Since epub files are generated and stored locally, you do not need reMarkable Cloud.

  • NodeJS and npm You can easily install both with toltec, a package manager for reMarakble devices:
opkg update
opkg install node-npm

How to use

  1. Clone repo:
git clone https://github.com/khanhas/hackernews2remarkable

If you don't have git, just download repo zip file and unzip:

wget "https://github.com/khanhas/hackernews2remarkable/archive/main.zip" -O "hackernews2remarkable.zip"
unzip "hackernews2remarkable.zip"
  1. Download dependencies:
cd hackernews2remarkable
npm install
  1. On your reMarkable device, create a Folder that will be used to store articles. You can name whatever you want, for example, I name it "HackerNews".
    Run following commands to find out what this new folder guid is:
grep -il '"visibleName": ".*HackerNews.*"' /home/root/.local/share/remarkable/xochitl/*.metadata

Your folder id should look somewhat similar to this: 764bceb9-abf1-4229-a025-f0dc59ac5c0c. Copy that id and set it in config.json.

  1. Run:
node main.js
  1. Restart reMarkable reading app:
systemctl restart xochitl

Credits

This project uses a modified version of epub-gen NPM package by cyrilis.

About

Fetch top articles from HackerNews, pack as EPUB right in your reMarkable device

License:MIT License


Languages

Language:HTML 74.3%Language:JavaScript 23.3%Language:CSS 2.3%