mdviewer's Introduction

mdviewer

This is a sample using the ov(oviewer) package.

Start with mdviewer markdown file.

mdviewer README.md

Rendered and displayed by glamour.

Press the ] key to see the original file.
Press the [ key to return.

See the ov for other operations.

Installation

go install

go install github.com/noborus/mdviewer@latest

Binary

Releases

Homebrew

brew install noborus/tap/mdviewer

Arch Linux

https://aur.archlinux.org/packages/mdviewer-git

deb

You can download the package from releases.

curl -L -O https://github.com/noborus/mdviewer/releases/download/vx.x.x/mdviewer_x.x.x-1_amd64.deb
sudo apt install ./mdviewer_x.x.x_amd64.deb

rpm

You can download the package from releases.

sudo rpm -ivh https://github.com/noborus/mdviewer/releases/download/vx.x.x/mdviewer_x.x.x-1_amd64.rpm

mdviewer's People

Contributors

Stargazers

Watchers

mdviewer's Issues

[FYI] Now available from ArchLinux User Repository (AUR)

I thought you'd like to learn that mdviewer is now available from AUR as mdviewer-git:

https://aur.archlinux.org/packages/mdviewer-git

🙏

[Enhancement] Options `-h`/`--help` and `-V`/`--version` would be nice

The current behaviour is suboptimal:

» mdviewer -h
2024/02/26 20:38:30 open -h: no such file or directory

Something like this is more helpful:

» mdviewer -h
usage: mdviewer [OPTIONS] FILE

Rendered display of markdown on terminal

positional arguments:
  FILE           markdown file to view

options:
  -h, --help     show this help message and exit
  -V, --version  show version information and exit

The version information is useful when reporting bugs, and to asses whether an installed binary is ripe for upgrade.

Recommend Projects