MDit logo

Project 06 · Open Source · Productivity

MDit

A sleek, distraction-free Markdown editor — live split preview with GFM, KaTeX math, and Mermaid diagrams; workspace search, Git panel, and professional export. Native Windows desktop and a web build from one React codebase.

2
Platforms
4
View Modes
CM6
Editor
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.

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
Web vs desktop
Capability Web Desktop
Edit & live preview
Open single files · GitHub import
Folder workspace · search · Git panel
File associations (.md)
Technology
ReactReact 18
TypeScriptTypeScript 5
Tauri 2desktop
CodeMirror 6
KaTeX · Mermaid
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+SSave
Ctrl+Shift+PCommand palette
Ctrl+Shift+FWorkspace search (desktop)
F11Focus mode
My Role

Author & maintainer — product design, React frontend, Tauri/Rust desktop shell, preview pipeline (remark/rehype), workspace and export features, documentation, and MIT release. Built for writers who want Markdown without the clutter.

Star on GitHub →