https://github.com/morinokami/tynx

https://github.com/morinokami/tynx

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/morinokami/tynx
• Owner: morinokami
• License: mit
• Created: 2021-03-21T15:50:09.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-12-12T08:03:24.000Z (about 3 years ago)
• Last Synced: 2024-11-13T06:13:21.574Z (about 1 month ago)
• Language: TypeScript
• Size: 3.62 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tynx

tynx is a simple text-based web reader written in TypeScript.

* converts a web page to markdown text and renders it.

* supports vim-like cursor movement.

![demo](./resources/demo.gif)

## Installation

```sh

$ npm install -g tynx

```

## Usage

```sh

$ tynx https://example.com

```

## Commands

* Cursor movement

  * `h`: move cursor left

  * `j`: move cursor down

  * `k`: move cursor up

  * `l`: move c rsor right

  * `0`: jump to the start of the line

  * `$`: jump to the end of the line

  * `g`: go to the first line of the document

  * `G`: go to the last line of the document

  * `Ctrl-f`: move forward one full screen

  * `Ctrl-b`: move back one full screen

* Navigation

  * `f`: follow the link under the cursor

  * `e`: enter a url and follow it

  * `r`: reload the document

  * `]`: navigate to the next page in history

  * `[`: navigate to the previous page in history

  * `H`: open history

* Other commands

  * `q`: quit

  * `?`: open help