{"id":13794550,"url":"https://github.com/khanhas/hackernews2remarkable","last_synced_at":"2025-05-12T21:31:43.047Z","repository":{"id":47171163,"uuid":"315242979","full_name":"khanhas/hackernews2remarkable","owner":"khanhas","description":"Fetch top articles from HackerNews, pack as EPUB right in your reMarkable device","archived":false,"fork":false,"pushed_at":"2021-09-10T03:50:47.000Z","size":33,"stargazers_count":98,"open_issues_count":1,"forks_count":4,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-08-03T23:03:43.209Z","etag":null,"topics":["hacker-news","remarkable-tablet"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/khanhas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-23T08:09:06.000Z","updated_at":"2024-08-02T15:08:19.000Z","dependencies_parsed_at":"2022-08-01T00:48:08.176Z","dependency_job_id":null,"html_url":"https://github.com/khanhas/hackernews2remarkable","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khanhas%2Fhackernews2remarkable","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khanhas%2Fhackernews2remarkable/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khanhas%2Fhackernews2remarkable/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khanhas%2Fhackernews2remarkable/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/khanhas","download_url":"https://codeload.github.com/khanhas/hackernews2remarkable/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225157000,"owners_count":17429698,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacker-news","remarkable-tablet"],"created_at":"2024-08-03T23:00:43.189Z","updated_at":"2024-11-18T09:30:39.286Z","avatar_url":"https://github.com/khanhas.png","language":"HTML","funding_links":[],"categories":["E-readers"],"sub_categories":["ReMarkable"],"readme":"# hackernews2remarkable\nFetch top articles from HackerNews, pack as EPUB right in your reMarkable device\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://i.imgur.com/lK0AlqI.png\" width=\"350\" title=\"Folder of articles\"\u003e\n  \u003cimg src=\"https://i.imgur.com/UBt2rPI.png\" width=\"350\" title=\"Article title and content\"\u003e\n  \u003cimg src=\"https://i.imgur.com/caONUHZ.png\" width=\"350\" title=\"Take notes on article\"\u003e\n\u003c/p\u003e\n\n## Requirements\n**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.\n\n- [NodeJS](https://nodejs.org/) and `npm`\nYou can easily install both with [toltec](https://github.com/toltec-dev/toltec/), a package manager for reMarakble devices:\n```bash\nopkg update\nopkg install node-npm\n```\n\n## How to use\n1. Clone repo:\n```bash\ngit clone https://github.com/khanhas/hackernews2remarkable\n```\n\nIf you don't have `git`, just download repo zip file and unzip:\n```bash\nwget \"https://github.com/khanhas/hackernews2remarkable/archive/main.zip\" -O \"hackernews2remarkable.zip\"\nunzip \"hackernews2remarkable.zip\"\n```\n\n2. Download dependencies:\n```bash\ncd hackernews2remarkable\nnpm install\n```\n\n3. 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\".  \nRun following commands to find out what this new folder guid is:\n```bash\ngrep -il '\"visibleName\": \".*HackerNews.*\"' /home/root/.local/share/remarkable/xochitl/*.metadata\n```\nYour folder id should look somewhat similar to this: `764bceb9-abf1-4229-a025-f0dc59ac5c0c`. Copy that id and set it in `config.json`.\n\n3. Run:\n```bash\nnode main.js\n```\n\n4. Restart reMarkable reading app:\n```bash\nsystemctl restart xochitl\n```\n\n## Credits\nThis project uses a modified version of [`epub-gen`](https://www.npmjs.com/package/epub-gen) NPM package by [cyrilis](https://github.com/cyrilis).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhanhas%2Fhackernews2remarkable","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkhanhas%2Fhackernews2remarkable","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhanhas%2Fhackernews2remarkable/lists"}