mdtv 0.1.0

A friendly, polished terminal Markdown viewer.

mdtv

mdtv is a friendly terminal Markdown viewer built with Typer and Textual.

Install

uv sync

Use

Open a file:

uv run mdtv README.md

Read from stdin:

cat README.md | uv run mdtv

Hide the contents sidebar:

uv run mdtv README.md --no-toc

The sidebar is closed by default. Press t to open it on the right side.

Start with a Textual theme:

uv run mdtv README.md --theme nord

Built-in themes include textual-dark, textual-light, nord, gruvbox, catppuccin-mocha, dracula, tokyo-night, monokai, flexoki, catppuccin-latte, solarized-light, solarized-dark, rose-pine, atom-one-dark, and atom-one-light.

Preferences

mdtv stores minimal preferences in ~/.mdtv.json:

{
  "theme": "textual-dark"
}

Selecting a theme with d updates that file. Sidebar visibility is session-only and always starts closed unless --toc is passed.

Development

uv run ruff format .
uv run ruff check .
uv run pytest

Keys

• Up / Down or k / j scroll line by line
• PageUp / PageDown scroll by page
• Space or f scrolls forward by page
• b scrolls backward by page
• Home jumps to the top
• End jumps to the bottom
• t toggles the contents sidebar
• d opens Textual's theme picker
• r reloads file-backed documents
• ? opens the help modal
• q or Esc quits