md

README

md

md is a simple Markdown renderer for the terminal that uses Glamour.

It exists because Glow didn't work well within the fzf preview when using custom styles and colors. md honors the GLAMOUR_STYLE environment variable and works with the Catppuccin Glamour theme.

• MD_WORD_WRAP: Set the word wrap width. Defaults to 80.
• MD_ADF: Set to true if the input is in Atlassian Document Format (ADF). Defaults to false.
• MD_RAW: Set to true to print the raw input instead of rendering it. Defaults to false.

Install

Releases

Check the releases page for the full list of pre-built binaries.

1. Download the release for your os/arch
2. Unzip the archive to get the md binary
3. Add the md binary to your PATH

Source

GOEXPERIMENT=jsonv2 go install github.com/ricoberger/md@latest

Development

To build and run the binary the following commands can be used:

GOEXPERIMENT=jsonv2 go build -o ./bin/md .
./bin/md