md-preview
Native, local-first Markdown preview and quick editor. Multi-document tabs, session restore, macOS Finder workflow, offline Mermaid/KaTeX. Rust + system WebView
What is md-preview?
Native, local-first Markdown preview and quick editor. Multi-document tabs, session restore, macOS Finder workflow, offline Mermaid/KaTeX. Rust + system WebView, no Electron.
Overview of md-preview
What it is
MD Preview is a native, local-first Markdown previewer and quick editor. It is built with Rust and the system WebView on desktop, with additional native shells for iOS and Android. It does not bundle Chromium or require Electron. All rendering assets—syntax highlighting, math formulas, and diagrams—work offline. The application is designed for users who need a fast, lightweight window for viewing and editing Markdown files without launching a full IDE. It supports multi-document tabs, session restore, and a macOS Finder workflow for creating and editing Markdown files directly from Finder. The project is open-source under the MIT license. Note that Apple platform downloads and package builds are currently suspended; the features described refer to retained source code only.
Key features
- Desktop tabs: Open multiple Markdown or text documents in one window; duplicate paths activate the existing tab.
- Session restore: Tab order and the active document are restored after restart; inactive content loads from disk only when selected.
- Reliable autosave: Source edits save after a short pause and are flushed before preview, tab switches, tab/window close, or quit; save failures keep the tab and text intact.
- Local document links: Relative or absolute links to existing Markdown and text files open or activate a tab; invalid local targets do not replace the preview.
- Offline rendering: KaTeX for math formulas and Mermaid for diagrams render locally when the document uses them.
- Live reload: External edits (e.g., from Vim, VS Code) refresh the rendered document automatically.
Use cases
- Keeping AI-generated plans, task notes, and READMEs open as tabs without opening a full IDE.
- Resuming the same tab order and active document after restarting the app.
- Making small source edits inside MD Preview while getting live reload when another editor writes the file.
- On macOS, creating a new Markdown document from Finder and landing directly in source edit.
- Printing or exporting the rendered preview as a clean PDF.
Getting started
bash git clone https://github.com/vorojar/md-preview.git cd md-preview cargo build --release ./target/release/md-preview README.md
License and pricing
This project is licensed under the MIT license. It is open-source and free.
Based on the project's public README and repository metadata.