https://github.com/akuli/md
Terminal markdown viewer
https://github.com/akuli/md
Last synced: 10 months ago
JSON representation
Terminal markdown viewer
- Host: GitHub
- URL: https://github.com/akuli/md
- Owner: Akuli
- License: mit
- Created: 2023-12-07T21:19:11.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-23T11:57:21.000Z (about 2 years ago)
- Last Synced: 2025-02-21T08:05:50.829Z (11 months ago)
- Language: Go
- Size: 58.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Markdown Viewer
This is a super simple markdown viewer written in Go
using [the glamour library](https://github.com/charmbracelet/glamour).
This project is not meant to be impressive or interesting in any way.
It is simply a much less bloated alternative to [glow](https://github.com/charmbracelet/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.