Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrusme/reader
reader is for your command line what the “readability” view is for modern browsers: A lightweight tool offering better readability of web pages on the CLI.
https://github.com/mrusme/reader
ascii ascii-art cli command-line command-line-tool html html-to-markdown markdown readability reader terminal terminal-based tui web
Last synced: about 1 month ago
JSON representation
reader is for your command line what the “readability” view is for modern browsers: A lightweight tool offering better readability of web pages on the CLI.
- Host: GitHub
- URL: https://github.com/mrusme/reader
- Owner: mrusme
- License: gpl-3.0
- Created: 2022-02-20T00:34:07.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-09-12T13:51:41.000Z (9 months ago)
- Last Synced: 2024-02-01T11:07:33.167Z (5 months ago)
- Topics: ascii, ascii-art, cli, command-line, command-line-tool, html, html-to-markdown, markdown, readability, reader, terminal, terminal-based, tui, web
- Language: Go
- Homepage: https://xn--gckvb8fzb.com/reader-web-page-readability-on-the-cli/
- Size: 21.4 MB
- Stars: 204
- Watchers: 4
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Lists
- cli-apps - reader - Reader parses a web page for its actual content and displays it in nicely highlighted text on the command line (<a name="viewers"></a>Viewers)
- awesome-stars - mrusme/reader - reader is for your command line what the “readability” view is for modern browsers: A lightweight tool offering better readability of web pages on the CLI. (Go)
- awesome-cli-apps - reader - Reader parses a web page for its actual content and displays it in nicely highlighted text on the command line (<a name="viewers"></a>Viewers)
README
reader
------
*reader* is for your command line what the “readability” view is for modern
browsers: A lightweight tool offering better readability of web pages on the
CLI.
`reader` parses a web page for its actual content and displays it in nicely
highlighted text on the command line. In addition, `reader` renders embedded
images from that page as colored block-renders on the terminal as well.
## Usage
```sh
reader https://xn--gckvb8fzb.com/superhighway84/
```
Don't render images:
```sh
reader --image-mode none https://xn--gckvb8fzb.com/superhighway84/
```
Output raw markdown, don't pretty print:
```sh
reader -o https://xn--gckvb8fzb.com/superhighway84/
```
Read from file:
```sh
reader ${HOME}/downloads/example.com.html
```
Read from stdin:
```sh
curl -o - https://superhighway84.com | reader -
```
Render images using the SIXEL graphics encoder:
```sh
reader --image-mode sixel https://xn--gckvb8fzb.com/travel-aruba/
```
More options:
```sh
reader -h
```
## Examples
### Using `reader` from within `w3m`
While on a web page in w3m, press `!` and enter the following:
```
reader $W3M_URL
```
This will open the current url with `reader`. `w3m` will wait for you to press
any key in order to resume browsing.
If you want to navigate through the page:
```
reader $W3M_URL | less -R
```
### Using `reader` from within `vim`/`neovim`
Add the following function/mapping to your `init.vim`:
```
function s:vertopen_url()
normal! "uyiW
let mycommand = "reader " . @u
execute "vertical terminal " . mycommand
endfunction
noremap vertopen_url : call vertopen_url()
nmap gx vertopen_url
```
Open a document and place the cursor on a link, then press `g` followed by `x`.
Vim will open a new terminal and show you the output of `reader`.