Categorygithub.com/Akuli/md
repositorypackage
0.0.0-20231223115819-c76dd0ac1316
Repository: https://github.com/akuli/md.git
Documentation: pkg.go.dev

# README

Markdown Viewer

This is a super simple markdown viewer written in Go using the glamour library.

screenshot

This project is not meant to be impressive or interesting in any way. It is simply a much less bloated alternative to glow, which uses the same rendering library.

Compiling

On Linux with apt:

$ sudo apt install golang
$ git clone https://github.com/Akuli/md
$ cd md
$ go build
$ ./md README.md

If you don't use linux or you don't have apt, install Go in whatever way works for you instead of running sudo apt install golang.

Installing

Once you have compiled md, simply copy the executable to some location on your PATH. For example:

$ cp md ~/bin/

Now you can run md somefile.md in any directory.