Skip to content
michaelsanfordPublic

About

Terminal-based cross-platform Markdown Reader

Topics

Resources

Stars

3 stars

Watchers

0 watching

Forks

Repository files navigation

mdr

CI Release License: MIT .NET 10 Security

GitHub release

Windows Winget

macOS Linux

A cross-platform terminal-based markdown renderer for .NET 10.

Renders markdown with full ANSI formatting — bold, italic, colors, syntax-highlighted code blocks, tables, and more — adapted to your terminal width. Includes an interactive pager with vim-style navigation and multiple color schemes.

Features

  • Headings — color-coded by level
  • Bold / Italic — native terminal formatting
  • Code blocks — bordered panels with language label and keyword highlighting (C#, JS/TS, Python, Rust, Go)
  • Inline code — distinct background
  • Tables — full-width with rounded borders
  • Lists — ordered, unordered, nested
  • Blockquotes — vertical bar + italic
  • Links — underlined with URL displayed
  • Horizontal rules
  • Interactive pager — scrollable output with status bar
  • Color schemes — cycle through Monokai, Dracula, Nord, GitHub Dark, Solarized, Catppuccin

Install

winget (Windows)

winget install michaelsanford.mdr

From source

Requires the .NET 10 SDK.

dotnet build -c Release

Or publish a native binary for your platform. Releases are compiled with NativeAOT — a self-contained native executable with no runtime dependency — so publishing requires the platform's C/C++ toolchain (prerequisites): the "Desktop development with C++" workload on Windows, clang + zlib1g-dev on Linux, and Xcode command line tools on macOS.

dotnet publish -c Release -r linux-x64
dotnet publish -c Release -r osx-arm64
dotnet publish -c Release -r win-x64

Usage

# Render a file
mdr README.md

# Pipe from stdin (bash)
cat README.md | mdr -

# Pipe from stdin (PowerShell)
Get-Content README.md | mdr -

When output exceeds the terminal height, mdr enters an interactive pager. If output is piped or fits on screen, it prints directly.

Keybindings

Key Action
↑ / k Scroll up
↓ / j Scroll down
PgUp / b Page up
PgDn / Space Page down
Home / g Jump to top
End / G Jump to bottom
t Cycle color scheme
q / Esc Quit

Color Schemes

Press t to cycle through:

  • Monokai — warm pinks, yellows, greens
  • Dracula — purples, pinks, cyans
  • Nord — cool blues, teals
  • GitHub Dark — blues, oranges, greens
  • Solarized — classic amber, teal
  • Catppuccin — soft pastels

Dependencies

License

MIT

About

Terminal-based cross-platform Markdown Reader

Topics

Resources

Stars

3 stars

Watchers

0 watching

Forks

Releases

Sponsor this project

Contributors

Languages