Skip to Content

Quick start

mddog previews Markdown in your terminal the way GitHub or Obsidian renders it. It works by building the page with macOS's own text and graphics engines, then sending the result to the terminal as images.

Why mddog?

Other terminal viewers render Markdown with only characters. Code editors render the real page but live outside the terminal. mddog renders the real page in your terminal, using a single binary without browser nor Electron.

mddogText-based terminal viewersCode editor preview
Stays in the terminal
Real fonts and heading sizes
Diagrams and math drawn as graphicsSome
ImagesSome
Live reloadSome
Preview pane in Claude Code

Compared in November 2026 to terminal viewers like glow, leaf, mdcat, Frogmouth, and rich-cli, and to the built-in Markdown previews in VS Code, Cursor, Zed, and JetBrains IDEs.

Requirements

See Compatibility for more info on the supported terminals.

Install

brew install qu8n/tap/mddog

To update, run brew upgrade mddog. If you use the Claude Code plugin, update the plugin too.

Install without Homebrew
curl -fsSL https://raw.githubusercontent.com/qu8n/mddog/main/install.sh | sh

The script downloads the latest release and puts the mdd binary in ~/.local/bin. To install somewhere else, set MDDOG_INSTALL_DIR to a folder you can write to. To update, run the script again.

Build from source

Install Rust first, then run:

git clone https://github.com/qu8n/mddog.git
cd mddog
cargo install --path .

This puts mdd in ~/.cargo/bin.

Uninstall

Remove the mdd binary, the image cache, and your config folder if you made one:

brew uninstall mddog   # or, if you used the script: rm ~/.local/bin/mdd
rm -rf ~/Library/Caches/mddog
rm -r ~/.config/mddog

Basic usage

mdd             # list Markdown files in the current directory to pick from
mdd README.md   # preview a file

Next steps

On this page