Skip to content

Latest commit

 

History

3 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mdview logo

mdview

Markdown, without the baggage. A 2.0 MB viewer, not another 200 MB editor — double-click any .md file to read it like a webpage, press F2 to edit in place.
Windows · macOS · Android  |  Built with Rust + WebView2, no Electron

Website · Download · Changelog · Blog · Docs

English · 简体中文 · 日本語 · Español · Français


Most of the time you open a .md file, you just want to read it — a README, some notes, an AI-generated answer. Booting a full editor for that is overkill. mdview opens it instantly like a webpage, and when you do need to edit, F2 gives you Obsidian-style WYSIWYG right inside the same window — no mode switch to another app.

  • Tiny app. 2.0 MB installer, opens in under a second, zero configuration
  • Zero clutter. Clean full-page reading — no toolbars, no sidebars you didn't ask for
  • Edit in place. F2 Obsidian-style WYSIWYG, F3 dual-column with live preview
  • 100% local — no account, no ads, your files never leave your computer

mdview rendering a Markdown file like a webpage — outline panel on the left, headings, lists, tables and a highlighted code block

Download

Platform Community (free forever) Pro ($6.99 lifetime)
Windows 10/11 mdview-setup-en-latest.exe mdview-setup-pro-en-latest.exe
macOS 11+ mdview-macos-en-latest.dmg mdview-macos-pro-en-latest.dmg
Android 7.0+ mdview.apk

Both editions are the same product and overwrite each other on install — switch anytime. Android is Community only.

In mainland China? Use the domestic edition instead — same app, distributed by www.mdview.cn with WeChat Pay (¥5 Pro lifetime unlock): download page.

SmartScreen warning? Windows flags apps without an expensive code-signing certificate. Click More info → Run anyway. mdview runs entirely locally and uploads nothing.

Why mdview

You double-click a .md file to read it — not to boot an IDE. Think Quick Look for Markdown:

mdview Typora / VS Code Browser extension
Install size 2.0 MB 100–400 MB — (but needs a browser)
Double-click a .md file Instant 3–5 s of editor startup Drag or copy-paste each time
Reading-first UI Zero chrome Toolbars, panels, tabs Browser UI around it
Built for Reading Writing code / docs Occasional preview

They complement each other — keep your editor for writing, use mdview for the 90% of times you just read.

Features

Preview

  • Double-click to open — installer auto-associates .md files; also Ctrl+O, drag-and-drop, and Explorer context menu
  • Live refresh — save in any editor and the page re-renders instantly (SSE push), keeping your scroll position
  • Outline panel — floating TOC with click-to-jump and scroll sync, plus History (grouped by day) and Favorites tabs
  • Reading position memory — reopens where you left off; single window per file
  • 9 color themes + dark/light mode — Glacier, Forest, Sunset, Typewriter… one right-click to switch
  • Type controls — pick any installed font; Ctrl+scroll for font size, Alt+scroll for column width (real reflow, not bitmap zoom)
  • Full rendering — tables with alignment, footnotes with back-links, local images, syntax-highlighted code blocks (copy / wrap / line numbers)
  • Export to PDF, single-newline-as-break toggle, GBK/GB18030 encoding fallback, auto update checks
mdview outline panel highlighting the current heading while scrolling mdview history panel grouping recently opened Markdown files by day
Outline tracks your scroll position History & favorites, grouped by day

9 color themes + dark mode, one right-click to switch:

mdview default light theme mdview dark mode theme mdview Glacier theme, cool blue tones mdview Typewriter theme, monospace style
Default Dark Glacier Typewriter
mdview Sunset theme, warm amber tones mdview Forest theme, calm green tones mdview Editorial theme, magazine serif style mdview Violet theme, purple tones
Sunset Forest Editorial Violet
mdview Lychee theme, soft red tones mdview Mint theme, fresh mint tones mdview Neon theme, vivid high contrast
Lychee Mint Neon

Editing

Key Mode Edition
F2 Live Edit — Obsidian-style WYSIWYG inside the preview: formatting, links, tables (row/column ops), callouts Pro
F3 Dual-column edit — source left, live preview right, scroll synced by section; Tab expands snippets; pasting an image/file auto-saves it to .__assets/ and inserts the Markdown Pro
F4 / Ctrl+E External edit — opens VS Code / Sublime / Notepad++ / Notepad (auto-detected) at the exact line of the selected text Free
Esc / Ctrl+W Close the window Free

mdview F3 dual-column editing: Markdown source on the left, live rendered preview on the right

Pro rendering

  • Mermaid diagrams (flowcharts / sequence / Gantt) with a double-click fullscreen viewer — wheel zoom, drag pan
  • KaTeX math formulas — inline $...$ and block $$...$$ LaTeX
  • Rendering engines download once on first use, then work fully offline
Mermaid flowchart rendered by mdview Pro inside a Markdown document KaTeX math formulas rendered by mdview Pro, BM25 equation in LaTeX
Mermaid diagrams KaTeX math

Pricing

Community Pro
Price Free forever (optional sponsorship) $6.99 one-time lifetime unlock (Gumroad: card / PayPal)
Core reading features ✅ everything ✅ everything
Mermaid + KaTeX
Live Edit (F2) + Dual-column edit (F3)
Trial 100 free opens, then a dismissible "Maybe Later" prompt — never hard-locks

Quick start

  1. Download and run the installer (or the portable mdview.exe)
  2. It automatically associates .md files (unbind anytime: right-click → Settings, or mdview --unbind)
  3. Double-click any Markdown file and read

Command line

mdview                     # run once: auto-associates .md files
mdview <file.md>           # preview a specific file
mdview --install           # add "Open with mdview" to the Explorer context menu
mdview --uninstall         # remove the context menu
mdview --settings          # settings window (association, recent files, editor)
mdview --unbind            # remove .md default association
mdview --help              # help

Environment variables

Variable Description
PORT HTTP server port (default: random free port, fallback 3456)
MD_HTML=1 Also output a rendered .html next to the .md file
MD_HTML_OUTPUT=<path> Output the .html to a specific path
MD_EDITOR Editor command for F4 (e.g. code --goto "{file}:{line}"); auto-detected if unset

FAQ

How do I open .md files on Windows?

Install mdview once and it associates .md files for you. From then on, double-click any Markdown file and it opens rendered like a webpage — no editor, no browser extension, no configuration.

Is mdview free?

Yes. The Community Edition is free forever with the full reading experience. The Pro Edition adds Mermaid diagrams, KaTeX math and two editing modes (F2 Live Edit, F3 dual-column) for a one-time $6.99 lifetime unlock — with 100 free trial opens first, and a dismissible "Maybe Later" prompt after that. It never hard-locks.

How is it different from Typora or VS Code?

Typora and VS Code are editors — powerful, but heavy when you only want to read. mdview is a dedicated viewer: a 2.0 MB installer that opens in under a second and closes with Esc. Think Quick Look for Markdown. They complement each other.

Does mdview upload my files?

No. mdview runs 100% locally. It only starts a temporary server on localhost to render the page — your Markdown never leaves your computer. No account, no ads, no tracking.

What are the system requirements?

Windows 10/11 with the WebView2 runtime (preinstalled on Windows 11 and most Windows 10 PCs) · macOS 11 Big Sur or later · Android 7.0 or later.

Tech stack

  • Language: Rust (edition 2021)
  • GUI: wry (WebView2) + tao
  • HTTP: axum + tokio (localhost only)
  • Markdown: embedded md4c
  • File watching: notify + SSE live reload
  • Styling: Tailwind CSS

About

mdview — a lightweight Markdown viewer for Windows, macOS & Android. Double-click any .md file to read it like a webpage; press F2 to edit in place. 2 MB installer, Rust + WebView2, 100% local. International edition: www.mdview.top — mainland China edition: www.mdview.cn

Topics

Resources

Stars

10 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors