MDit logo

Project 06 · v1.0.0 · Open Source

MDit

A sleek, distraction-free Markdown editor — live split preview with GFM, KaTeX math, and Mermaid diagrams; workspace search, Git panel, and professional export. Try it in the browser or install the native Windows app — one React codebase, two platforms.

v1.0
Released
2
Platforms
4
View Modes
MIT
License
Overview

MDit is a fast, local-first Markdown editor for writers, developers, and document authors. A CodeMirror 6 writing surface pairs with a rich live preview — GitHub Flavored Markdown, KaTeX math, Mermaid diagrams, inline SVG, emoji, footnotes, and YAML front matter — with linked selection and scroll sync in split view.

One shared React 18 + TypeScript frontend powers both targets: the web build runs in the browser for quick editing and GitHub import; the desktop app (Tauri 2 + Rust + WebView2) adds folder workspaces, full-text search, Git status, file associations, and native dialogs. Markdown, done well.

Writing & preview

Edit and preview

Live split preview

Resizable editor and preview with scroll sync and linked selection.

View modes

Edit · Split · Preview · Present — slide mode for decks.

Rich content

GFM tables, KaTeX $...$, Mermaid flowcharts, inline SVG.

Writing tools

Slash commands, Markdown lint, Vim/Emacs keymaps, typewriter mode.

Multi-tab

Pin, reorder, split editor, snapshots (Ctrl+Shift+K), session restore.

Wiki links

[[page]] navigation across workspace markdown files.

Workspace

Desktop power tools

Project folders

File tree with new, rename, delete, and reveal in Explorer.

Workspace search

Full-text across all .md files — Ctrl+Shift+F.

Git panel

Branch name and changed-files list at a glance.

GitHub import

Pull a file, Gist, or whole public repo into the editor.

Document outline

Click headings to jump; YAML front matter metadata panel.

Command palette

Ctrl+Shift+P — templates, themes, export, and every action.

Productivity

Built for focus

Auto-save

Configurable delay — saves to disk after you pause typing.

Session restore

Reopen tabs and workspace automatically on launch.

Templates

Meeting notes and snippets via command palette.

Focus mode

F11 distraction-free writing; preview themes Default · GitHub · Solarized.

Accessibility

High contrast, reduced motion, customizable keyboard shortcuts.

Word goal

Target count and progress in the status bar.

Export
HTMLSelf-contained export with embedded CSS
Word / ODTShareable document formats
Print / PDFSystem print dialog
Static sitePublish workspace folder to HTML
ClipboardCopy rendered HTML or raw Markdown
Custom CSSStyle preview and HTML output
Download

MDit v1.0.0 is available for Windows 10/11 (64-bit). Requires WebView2 (pre-installed on Windows 11). Registers as default editor for .md, .markdown, and .mdx.

Or use the web app — no install, full editing and GitHub import in Chrome or Edge.

Web vs desktop
Capability Web Desktop
Edit & live preview · GFM · math · Mermaid
Open files · GitHub import · export
Command palette · snapshots · auto-save
Folder workspace · full-text search · Git panel
Publish workspace · reveal in Explorer
File associations (.md · .mdx)

The web build ships production-grade SEO — JSON-LD schema, Open Graph, PWA manifest, sitemap, and crawler-friendly noscript content — deployable to Vercel or any static host.

Technology
ReactReact 18
TypeScriptTypeScript 5
Tauri 2desktop
CodeMirror 6
KaTeX · Mermaid
VercelVercel · PWA
GitZustand · Vite
Quick start
git clone https://github.com/OmarSharaf/MDit.git
cd MDit && npm install

npm run dev          # web → http://localhost:1420
npm run tauri dev    # desktop (Windows)

npm run build        # web production → dist/
npm run tauri build  # desktop installer
Shortcuts
Ctrl+NNew file · Ctrl+OOpen
Ctrl+SSave · Ctrl+FFind & replace
Ctrl+Shift+PCommand palette · /Slash commands
Ctrl+Shift+FWorkspace search (desktop) · Ctrl+Shift+KSnapshots
Ctrl+\Toggle sidebar · F11Focus mode
My Role

Author & maintainer — product design, React frontend, Tauri/Rust desktop shell, preview pipeline (remark/rehype), workspace and export features, web SEO/PWA layer, v1.0.0 Windows release, documentation, and MIT open source. Markdown, done well.

Try MDit → Star on GitHub