Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tuananh/reader
get a reader mode sharable url for any url - built with cloudflare workers https://reader.tuananh.net
https://github.com/tuananh/reader
cloudflare-workers reader-mode serverless
Last synced: 2 months ago
JSON representation
get a reader mode sharable url for any url - built with cloudflare workers https://reader.tuananh.net
- Host: GitHub
- URL: https://github.com/tuananh/reader
- Owner: tuananh
- Archived: true
- Created: 2020-02-05T02:33:54.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-10T03:25:15.000Z (over 1 year ago)
- Last Synced: 2024-04-08T18:50:24.720Z (6 months ago)
- Topics: cloudflare-workers, reader-mode, serverless
- Language: JavaScript
- Homepage:
- Size: 558 KB
- Stars: 25
- Watchers: 4
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
🤓 reader
=========
# DEPRECATED: See [tuananh/reader2](https://github.com/tuananh/reader2).
Update: new version is available at https://reader-next.pages.dev
preview url
```
https://reader-next.pages.dev?url=https://netflixtechblog.medium.com/cache-warming-leveraging-ebs-for-moving-petabytes-of-data-adcf7a4a78c3
```
An attempt to build a reader mode for any url with [Cloudflare workers](https://workers.cloudflare.com/).
While reader mode is built-in in pretty much all browsers, getting a reader mode sharable link is not possible. This project is an attempt to solve that problem.
The end goal is like to get a sharable url [like this](https://reader.tuananh.net/?url=https://www.theverge.com/2020/2/5/21124201/bill-simmons-the-ringer-spotify-acquistion-podcast-purchase)
```
https://reader.tuananh.net/?url=https://www.theverge.com/2020/2/5/21124201/bill-simmons-the-ringer-spotify-acquistion-podcast-purchase
```
Upon navigating to the above url, it will render the target domain in reader mode.
## Features
* Get a pretty, sharable reader mode url.
* Bypass subscription.
* Cached by Cloudflare.
* Respect OS prefer color scheme (dark mode).
* Minimal CSS.
* Return JSON if request `Content-Type` is `application/json`. Effectively become an API to extract text.
## TODO
* [x] Dark mode.
* [x] Use a more lightweight css framework instead of milligram.
* [ ] Let user manually override preferred color scheme.
## Usage
You can setup a bookmarklet to use this.
```
javascript:(function()%7Bwindow.open('https%3A%2F%2Freader.tuananh.net%2F%3Furl%3D'%2Bwindow.location.href%2C%20'_blank')%7D)()
```
## License
Copyright 2020 Tuan Anh Tran
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.