Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/khanhas/hackernews2remarkable
Fetch top articles from HackerNews, pack as EPUB right in your reMarkable device
https://github.com/khanhas/hackernews2remarkable
hacker-news remarkable-tablet
Last synced: 3 months ago
JSON representation
Fetch top articles from HackerNews, pack as EPUB right in your reMarkable device
- Host: GitHub
- URL: https://github.com/khanhas/hackernews2remarkable
- Owner: khanhas
- License: mit
- Created: 2020-11-23T08:09:06.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-09-10T03:50:47.000Z (about 3 years ago)
- Last Synced: 2024-04-06T07:34:41.573Z (7 months ago)
- Topics: hacker-news, remarkable-tablet
- Language: HTML
- Homepage:
- Size: 32.2 KB
- Stars: 94
- Watchers: 6
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hackernews - hackernews2remarkable - Fetch top articles, pack as EPUB right in your reMarkable device. `MIT` (E-readers / ReMarkable)
README
# 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](https://nodejs.org/) and `npm`
You can easily install both with [toltec](https://github.com/toltec-dev/toltec/), a package manager for reMarakble devices:
```bash
opkg update
opkg install node-npm
```
## How to use
1. Clone repo:
```bash
git clone https://github.com/khanhas/hackernews2remarkable
```
If you don't have `git`, just download repo zip file and unzip:
```bash
wget "https://github.com/khanhas/hackernews2remarkable/archive/main.zip" -O "hackernews2remarkable.zip"
unzip "hackernews2remarkable.zip"
```
2. Download dependencies:
```bash
cd hackernews2remarkable
npm install
```
3. 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:
```bash
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`.
3. Run:
```bash
node main.js
```
4. Restart reMarkable reading app:
```bash
systemctl restart xochitl
```
## Credits
This project uses a modified version of [`epub-gen`](https://www.npmjs.com/package/epub-gen) NPM package by [cyrilis](https://github.com/cyrilis).