mdv — terminal markdown viewer

mdv is a small, full-screen terminal viewer for Markdown files. It pages large documents, supports mouse-wheel and vim-style scrolling, and renders inline links as clickable OSC 8 hyperlinks in compatible terminals.

Built on mate, a Go TUI component framework.

Install

Prebuilt binaries

Grab the archive for your OS/arch from the latest release, extract, and place mdv somewhere on your PATH.

With Go

go install github.com/muralx/mdv@latest

From source

git clone https://github.com/muralx/mdv
cd mdv
go build .

Usage

mdv path/to/file.md

Controls

Key	Action
↑ / k	Scroll up one line
↓ / j	Scroll down one line
PgUp	Scroll up one page
PgDn	Scroll down one page
Home	Jump to top
End	Jump to bottom
Esc / q	Quit
Shift+drag	Select and copy text

Mouse-wheel scrolling is also supported.

Rendering

• Headings — #, ##, ###
• Bold — **text**
• Inline code — `code`
• Fenced code blocks
• Links — [text](url) rendered as clickable OSC 8 hyperlinks
• Tables — passed through as-is
• Horizontal rules — ---, ***, ___

Configuration

MDV_COLOR selects the color profile when terminal auto-detection isn't appropriate — for example, inside tmux/screen with TERM=screen-* and no COLORTERM, where auto-detection can block on terminal queries.

Value	Profile
(unset)	True color
ansi256	256 colors
ansi	16 colors
off / none / ascii	No color

License

MIT