No crazy syntax. No required directory structures. Just markdown.
Most static site generators force you into their world: custom folder layouts, proprietary frontmatter, bespoke shortcodes. mbr takes a different approach. Point it at any collection of markdown files and it just works for previewing a single file, browsing thousands of notes, or building a deployable website.
And unlike other markdown previewers, this one allows quick navigation between markdown files.
| Feature | Description |
|---|---|
| Instant Preview | Sub-second markdown rendering with live reload |
| Native GUI | macOS/Linux app with native menus and shortcuts (Windows should work, but is untested) |
| Static Sites | Generate deployable websites with full-text search |
| Smart Navigation | Browse by folders, tags, recents, and full-text search |
| Keyboard Friendly | Vim-like shortcuts are available for everything in the UI |
| Rich Media | Embed videos, audio, PDFs, and YouTube with simple markdown standard syntax |
| Fully Customizable | Override themes, templates, and UX per-repo |
# Using Nix to quick run without installing
nix run github:zmre/mbr -- -g /path/to/notes
# Using Cargo
cargo install --git https://github.com/zmre/mbrFile an issue if you want it packaged in a particular way.
mbr README.md # Render to stdout
mbr -s ~/notes # Start web server at http://127.0.0.1:5200/
mbr -g ~/notes # Launch native GUI window
mbr -b ~/notes # Build static site to ./build/See the full documentation for detailed guides. The documentation site itself is built with mbr, serving as a live example of its capabilities.
- Getting Started - Installation and first steps
- Modes of Operation - GUI, Server, Build, and QuickLook
- Customization - Themes, templates, and components
- Markdown Extensions - Extended syntax reference
- Architecture - Technical overview
- Development - Building and contributing
MIT - see LICENSE for details.