{"id":15460427,"url":"https://github.com/schollz/readable","last_synced_at":"2026-03-02T11:31:09.646Z","repository":{"id":57571630,"uuid":"98030685","full_name":"schollz/readable","owner":"schollz","description":"Making web pages readable in a browser and in the command line :link: :book:","archived":false,"fork":false,"pushed_at":"2017-10-04T22:02:43.000Z","size":1621,"stargazers_count":48,"open_issues_count":2,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-01-24T02:57:10.687Z","etag":null,"topics":["docker","docker-image","readable","web-parser"],"latest_commit_sha":null,"homepage":"https://readable.schollz.com","language":"Go","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/schollz.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":"2017-07-22T12:43:40.000Z","updated_at":"2026-01-10T14:35:51.000Z","dependencies_parsed_at":"2022-08-29T15:40:32.259Z","dependency_job_id":null,"html_url":"https://github.com/schollz/readable","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/schollz/readable","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schollz%2Freadable","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schollz%2Freadable/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schollz%2Freadable/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schollz%2Freadable/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/schollz","download_url":"https://codeload.github.com/schollz/readable/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schollz%2Freadable/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30000028,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-02T11:09:27.951Z","status":"ssl_error","status_checked_at":"2026-03-02T11:08:53.255Z","response_time":60,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["docker","docker-image","readable","web-parser"],"created_at":"2024-10-01T23:21:51.982Z","updated_at":"2026-03-02T11:31:09.458Z","avatar_url":"https://github.com/schollz.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Readable \n\nMaking web pages readable in a browser and in the command line :link: :book:.\n\nThis is like a self-hosted version of [Pocket](https://getpocket.com/), or [Firefox Reader View](https://support.mozilla.org/en-US/kb/firefox-reader-view-clutter-free-web-pages), or any other extension that helps you read an article on the web when using a Desktop browser. But, instead of a browser extension that you have to install, its just a bookmark you can keep on your toolbar or a single line of bash you can run at the terminal.\n\nWebsites are parsed with either [the free Mercury Web Parser API](https://mercury.postlight.com/web-parser/) or a self-hosted version of [Mozilla's *readability* package](https://github.com/mozilla/readability). The *readability* package was trasnformed into a Docker image that automatically performs some UTF-8 conversions and tidying.\n\n# Demo\n\nTry it out at [readable.schollz.com](https://readable.schollz.com). \n\n[![Readable example](https://user-images.githubusercontent.com/6550035/31201819-59d78922-a91d-11e7-8bc5-b9b2668d0123.png)](https://readable.schollz.com)\n\n# Quickstart\n\nFirst [download the latest release of *readable* for your OS](https://github.com/schollz/readable/releases/latest). Alternatively, if you have Go installed you can do `go get github.com/schollz/readable`.\n\nYou can run *readable* with or without Docker.\n\n## with Docker\n\n```shell\n$ docker pull schollz/readable\n$ ./readable\n```\n\n## without Docker \n\nGet `YOUR_API_KEY` Mercury Web Parser API Key [from here (its free)](https://mercury.postlight.com/web-parser/).\n\n```shell\n$ readable -key YOUR_API_KEY\n```\n\n# Advanced usage\n\nThe Docker image in this repo allows you to manipulate websites into readable ones. You can do some neat things like the following:\n\n## Read articles from the command line\n\nYou can use the Docker image to directly read articles from the command line:\n\n```\n$ URL=http://www.cnn.com/2017/10/03/world/nobel-physics-prize-2017/index.html\n$ docker run --rm -t schollz/readable $URL | more\n\n----------------------------------------------------------\nNobel Prize in Physics goes to 'black hole telescope' trio\n----------------------------------------------------------\n\nStory highlights\n\n-   The development proves Einstein's prediction of gravitational waves\n-   More than 1,000 people worked on the technology over four decades\n\n(CNN)The 2017 Nobel Prize in Physics has been awarded to Rainer Weiss,\nBarry C. Barish and Kip S. Thorne for their detection of gravitational\nwaves, a development scientists believe could give vital clues to the\norigins of the universe.\n...\n```\n\n## Download readable data to computer\n\nYou can use the Docker image to download the parsed contents into a json file:\n\n```shell\n$ URL=http://www.cnn.com/2017/10/03/world/nobel-physics-prize-2017/index.html\n$ docker run --rm -v `pwd`:/data -t schollz/readable $URL data.json\n$ cat data.json | jq .title\n\"Nobel Prize in Physics goes to 'black hole telescope' trio\"\n```\n\nwhere `URL` is the URL of some article that you want to read. This will result in a file `data.json` which contains the results.\n\nLicense\n=======\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fschollz%2Freadable","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fschollz%2Freadable","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fschollz%2Freadable/lists"}