md

command module
v0.0.0-...-c76dd0a Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 23, 2023 License: MIT Imports: 5 Imported by: 0

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.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL