{"id":15654652,"url":"https://github.com/gowee/readability-bot","last_synced_at":"2025-10-06T21:56:38.808Z","repository":{"id":114846980,"uuid":"399360082","full_name":"Gowee/readability-bot","owner":"Gowee","description":"A Telegram bot that makes webpages \"readable\" (Instant View \u0026 Inline Mode)","archived":false,"fork":false,"pushed_at":"2025-05-19T05:28:10.000Z","size":121,"stargazers_count":33,"open_issues_count":2,"forks_count":10,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-19T06:29:34.711Z","etag":null,"topics":["instant-view","readability","telegram-bot"],"latest_commit_sha":null,"homepage":"https://t.me/ReadabBot","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Gowee.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-08-24T06:32:26.000Z","updated_at":"2025-05-19T05:28:14.000Z","dependencies_parsed_at":null,"dependency_job_id":"8b9d449f-2f28-443a-b771-a405f64e7e55","html_url":"https://github.com/Gowee/readability-bot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Gowee/readability-bot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gowee%2Freadability-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gowee%2Freadability-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gowee%2Freadability-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gowee%2Freadability-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Gowee","download_url":"https://codeload.github.com/Gowee/readability-bot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Gowee%2Freadability-bot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278686633,"owners_count":26028325,"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","status":"online","status_checked_at":"2025-10-06T02:00:05.630Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["instant-view","readability","telegram-bot"],"created_at":"2024-10-03T12:53:06.002Z","updated_at":"2025-10-06T21:56:38.789Z","avatar_url":"https://github.com/Gowee.png","language":"JavaScript","readme":"# Readability Bot\n\nA wrapper around [Readability.js](https://github.com/mozilla/readability).\n\n_Telegram bot: [@Readabbot](https://t.me/readabbot)_\n\n_Web app: https://readability-bot.vercel.app_\n\n## API\n\n**Endpoint**: `/api/readability?url={URL}\u0026format=json` ([e.g.](https://readability-bot.vercel.app/api/readability?url=https%3A%2F%2Fwww.zaobao.com%2Fnews%2Fchina%2Fstory20211002-1199284\u0026format=json))\n\nReturns a self-explanatory JSON inherited from Readability.js.\n\n## Instant View for any\\* website\n\n### Bot\n\nThe Telegram bot returns \"readable\" articles with Instant View enabled automatically.\n\n### Web service\n\nIt is also possbile to apply a quick Instant View to any\\* website programmatically with the help of the web service.\nAssuming `ARTICLE_TITLE=\"Lorem Ipsum\"`, `ARTICLE_URL=\"https://example.org/blog-post/1\"` and `CHANNEL` is the ID of channel, which typically is the subscribing channel for a (news/blog/etc.) website:\n\n**JavaScript**:\n\n```js\nconst readableUrl = `https://readability-bot.vercel.app/api/readability?url=${encodeURIComponent(\n  ARTICLE_URL\n)}`;\nconst ivUrl = `https://t.me/iv?url=${encodeURIComponent(\n  readableUrl\n)}\u0026rhash=71b64d09b0a20d`;\n\nconst message = `\u003ca href=\"${ivUrl}\"\u003e \u003c/a\u003e\u003ca href=\"${articleUrl}\"\u003e${ARTICLE_TITLE}\u003c/a\u003e`;\nbot.sendMessage(CHANNEL, message, (parseMode = \"html\"));\n```\n\n**Python**:\n\n```py\n  import urllib.parse import quote as percent_encode\n  # ... ...\n  readable_url = f'https://readability-bot.vercel.app/api/readability?url={percent_encode(ARTICLE_URL, safe=\"\")}';\n  iv_url = f'https://t.me/iv?url={percent_encode(readable_url, safe=\"\")}\u0026rhash=71b64d09b0a20d';\n\n  message = f'\u003ca href=\"{iv_url}\"\u003e \u003c/a\u003e\u003ca href=\"{article_url}\"\u003e{articleTitle}\u003c/a\u003e';\n  bot.send_message(CHANNEL, message, parse_mode=\"html\") # await it?\n```\n\n\u003csup\u003e\u003csub\u003e\\*: Almost, with no guarantee. Compatibility issues for specific websites are generally not accepted in this project. Please report those to [readability.js](https://github.com/mozilla/readability), **if applicable**.\u003c/sub\u003e\u003c/sup\u003e\n\n## Deploy Your Own\n\n[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/gowee/readability-bot\u0026template=svelte)\n\nAnd, some [environment variables](https://vercel.com/docs/concepts/projects/environment-variables) are expected:\n- [`BOT_TOKEN`](https://core.telegram.org/bots/features#botfather): REQUIRED for the bot service. Do not forget to [set the webhook address](https://core.telegram.org/bots/webhooks#how-do-i-set-a-webhook-for-either-type) to `{APP_URL}/api/webhook`.\n- `APP_URL`: Optional, inferred automatically from Vercel runtime. e.g. `https://readability-bot.vercel.app`\n- `READABILITY_API_URL`: Optional, inferred automatically from Vercel runtime. e.g. `https://readability-bot.vercel.app/api/readability`\n- `IV_RHASH`: Optional, [71b64d09b0a20d](rules.iv) is used by default.\n\n### Run locally\n`npx vercel dev`\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgowee%2Freadability-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgowee%2Freadability-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgowee%2Freadability-bot/lists"}