Light

khanhas / hackernews2remarkable Goto Github PK

View Code? Open in Web Editor NEW

96.0 6.0 4.0 33 KB

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

License: MIT License

JavaScript 23.33% HTML 74.32% CSS 2.35%

remarkable-tablet hacker-news

hackernews2remarkable's Introduction

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

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"

Download dependencies:

cd hackernews2remarkable
npm install

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.

Run:

node main.js

Restart reMarkable reading app:

systemctl restart xochitl

Credits

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

hackernews2remarkable's People

Contributors

Stargazers

Watchers

Forkers

hirajanwin gordol asierzapata lambdamonkey

hackernews2remarkable's Issues

Clarify use of reMarkable Cloud API

I've only skimmed through your code but it looks like you don't rely on the reMarkable Cloud API, but I might be wrong.
I personally don't use the reMarkable Cloud and love projects that don't rely on it.

It'd be great if you could add a note to clarify if you are using it or not, I'm sure a lot a future users passing through are asking themselves the same question.

Recommend Projects

React

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

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

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

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
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.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

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

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.