mkdedit

A lightweight, cross-platform Markdown editor with live preview. Built with SolidJS and Tauri for native desktop performance.

Features

• Live Preview - See your Markdown rendered in real-time as you type
• GitHub-Flavored Markdown - Tables, strikethrough, task lists, and fenced code blocks
• Native File Dialogs - Open, save, and create files with native OS dialogs
• Resizable Split Pane - Drag the splitter to adjust editor/preview ratio
• Keyboard Shortcuts - Ctrl+S to save
• Cross-Platform - Runs on Windows, macOS, and Linux

Installation

Download the latest release for your platform from the Releases page.

Building from Source

Prerequisites:

• Node.js 18+
• pnpm
• Rust

# Clone the repository
git clone https://github.com/appurist/mkdedit.git
cd mkdedit

# Install dependencies
pnpm install

# Run in development mode
pnpm tauri:dev

# Build for production
pnpm tauri:build

Platform-Specific Builds

pnpm tauri:build:win    # Windows (NSIS installer + MSI)
pnpm tauri:build:mac    # macOS (DMG + .app bundle)
pnpm tauri:build:linux  # Linux (DEB + AppImage)

Development

pnpm dev          # Start Vite dev server only
pnpm tauri:dev    # Start full Tauri development environment

Tech Stack

• Frontend: SolidJS - Reactive UI framework
• Markdown: marked - Fast Markdown parser
• Desktop: Tauri v2 - Lightweight native app framework
• Build: Vite - Fast frontend tooling

License

MIT License - see LICENSE for details.