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: 14 days 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: 2024-08-01T20:11:52.000Z (3 months ago)
• Last Synced: 2024-10-18T06:36:30.262Z (26 days 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.3 MB
• Stars: 277
• Watchers: 5
• Forks: 11
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
reader

------

[![Static 

Badge](https://img.shields.io/badge/Join_on_Matrix-green?style=for-the-badge&logo=element&logoColor=%23ffffff&label=Chat&labelColor=%23333&color=%230DBD8B&link=https%3A%2F%2Fmatrix.to%2F%23%2F%2521PHlbgZTdrhjkCJrfVY%253Amatrix.org)](https://matrix.to/#/%21PHlbgZTdrhjkCJrfVY%3Amatrix.org)

*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](demo.gif)

`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.

## Installation 

```

go install github.com/mrusme/reader@latest

```

If the above fails, then the following should work:

```

git clone https://github.com/mrusme/reader.git

cd reader

go install 

```

## 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/

```

![sixel](sixel.png)

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`.