Skip to content
kohnalexPublic

About

A lightweight GUI for Markdown files launched from the terminal

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mdread

A lightweight Markdown reader for macOS. Open any Markdown file from the terminal in a native window.

mdread README.md

Install

Requires Rust.

cargo install --path .

Usage

mdread README.md
mdread ../docs/intro.md
mdread "/Users/me/My Project/notes.md"

Keyboard Shortcuts

Key Action
Ctrl+J / Ctrl+N Scroll down
Ctrl+K / Ctrl+P Scroll up
Ctrl+D Half page down
Ctrl+U Half page up
Arrow keys Scroll
Page Up / Page Down Scroll by page
Home / End Jump to top / bottom
Cmd+W / Cmd+Q Close

Mouse wheel and trackpad scrolling also work.

Rendering

Supports headings, bold, italic, inline code, fenced code blocks, bullet and numbered lists, blockquotes, links, tables, horizontal rules, strikethrough, and task lists. Links open in your default browser. Respects macOS light/dark mode.

How It Works

Rust CLI that parses Markdown to HTML with pulldown-cmark and renders it in a native macOS WebView (wry + tao). No Electron. ~1.8MB binary.

License

MIT

About

A lightweight GUI for Markdown files launched from the terminal

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages