1 unstable release
Uses new Rust 2024
| new 0.26.0 | Mar 24, 2026 |
|---|
#886 in GUI
370KB
9K
SLoC
โจ Features
๐๏ธ Edit ยท Preview ยท Side-by-side โ three modes, one keystroke to switch
๐จ Syntax highlighting โ headings, code fences, bold, links, and more
๐ Navigation panel โ jump to any heading instantly
๐ Find & Replace โ search across your document
๐ Format on demand โ respects .editorconfig (trailing whitespace, final newline, line endings)
๐๏ธ Live preview โ full GFM rendering with tables, task lists, strikethrough, and images
โก Fast โ native GPU-accelerated UI, instant startup, zero Electron
๐ Live reload โ detects external file changes with 3-way merge for dirty buffers
๐พ Remembers your preferences โ zoom, mode, nav panel, and heading colours persist across sessions
๐ฑ๏ธ Drag & drop โ open .md files by dropping them in
๐ฆ Install
Download a pre-built binary from Releases, or build from source:
cargo install --git https://github.com/teh-hippo/rustdown.git rustdown
Linux runtime dependencies
Most desktop environments already have these. Minimal installs (including WSL) may need:
sudo apt-get install libwayland-client0 libxkbcommon0 libxkbcommon-x11-0 libgtk-3-0
๐ Usage
rustdown # new document
rustdown README.md # open a file (starts in Preview mode)
rustdown -s README.md # open in Side-by-side mode
rustdown -p # start in Preview mode
โจ๏ธ Keyboard Shortcuts
Ctrl on Linux/Windows, Cmd on macOS.
| Shortcut | Action |
|---|---|
Ctrl+O |
Open |
Ctrl+S |
Save |
Ctrl+Shift+S |
Save As |
Ctrl+N |
New document |
Ctrl+F |
Find |
Ctrl+Shift+F |
Find & Replace |
Ctrl+Alt+F |
Format |
Ctrl+Enter |
Cycle mode |
Ctrl+Shift+T |
Toggle nav panel |
Ctrl+Plus/Minus |
Zoom |
Ctrl+Shift+F11 |
Open demo document |
Ctrl+Shift+F12 |
Open verification document |
๐ฅ๏ธ Platforms
| Platform | Architecture | Status |
|---|---|---|
| Linux | x86_64 | โ CI |
| Windows | x86_64 | โ CI |
License
Bundled fonts are licensed separately โ see THIRD-PARTY-NOTICES.md.
lib.rs:
rustdown-md โ a custom Markdown preview renderer for egui.
Renders parsed Markdown (via pulldown-cmark) directly into egui widgets,
supporting configurable heading colours/sizes and viewport-culled scrolling.
Dependencies
~6MB
~114K SLoC