MDPX

A modern, lightweight markdown editor with live preview. Built for speed and simplicity.

Features

Editor

• Live Preview: See your markdown rendered in real-time as you type
• Split Pane View: Edit and preview side-by-side
• Auto-Save: Never lose your work
• Syntax Highlighting: Code blocks with Fira Code font
• Smart Typography: Automatic smart quotes and dashes

Export

Export your documents to multiple formats:

• PDF - Professional documents with customizable page size and margins
• HTML - Standalone HTML files with embedded styles
• DOCX - Microsoft Word compatible documents
• Plain Text - Clean text output
• Markdown - Save a copy of your markdown

Productivity

• Command Palette (Cmd/Ctrl+Shift+P) - Quick access to all commands
• Keyboard Shortcuts - Full keyboard navigation
• Settings Panel - Customize editor preferences
• Help Documentation - Built-in keyboard shortcut reference

Installation

macOS

Download the latest .dmg installer from Releases and drag MDPX to your Applications folder.

Windows

Download the latest .exe installer from Releases and run the setup wizard.

Linux

Download the latest .AppImage from Releases, make it executable, and run:

chmod +x MDPX-Linux-*.AppImage
./MDPX-Linux-*.AppImage

Keyboard Shortcuts

File Operations

• Cmd/Ctrl+N - New document
• Cmd/Ctrl+O - Open document
• Cmd/Ctrl+S - Save document
• Cmd/Ctrl+Shift+S - Save as
• Cmd/Ctrl+E - Export document
• Cmd/Ctrl+P - Print

Editing

• Cmd/Ctrl+B - Bold selection
• Cmd/Ctrl+I - Italic selection
• Cmd/Ctrl+K - Insert link
• Cmd/Ctrl+1-6 - Insert heading (H1-H6)
• Cmd/Ctrl+Z - Undo
• Cmd/Ctrl+Shift+Z - Redo

View

• Cmd/Ctrl+\\ - Toggle preview pane
• Cmd/Ctrl+= - Zoom in
• Cmd/Ctrl+- - Zoom out
• Cmd/Ctrl+0 - Reset zoom

Application

• Cmd/Ctrl+Shift+P - Open command palette
• Cmd/Ctrl+, - Open settings
• Cmd/Ctrl+Shift+H or ? - Open help

Export Options

PDF Export

• Page sizes: A4, Letter, Legal, A5
• Margins: None, Narrow, Normal, Wide
• Orientation: Portrait or Landscape
• Optional image embedding

HTML Export

• Standalone files with embedded CSS
• Optional image embedding
• Responsive design

DOCX Export

• Microsoft Word compatible
• Preserves formatting
• Includes images

Development

Prerequisites

• Node.js 20 or higher
• npm or yarn

Setup

# Clone the repository
git clone https://github.com/yourusername/mdpx.git
cd mdpx

# Install dependencies
npm install

# Run in development mode
npm run dev

Build

# Build for your current platform
npm run build

# Installers will be in: release/{version}/

Tech Stack

• Framework: Electron
• UI: React + TypeScript
• Styling: Styled Components
• State Management: Zustand
• Markdown: Marked + Smartypants
• Build: Vite + electron-builder

Configuration

Editor Settings

• Font size (10-32px)
• Word wrap toggle
• Auto-save preferences

Export Defaults

• Default page size
• Default margins
• Image embedding preferences

Access settings via Cmd/Ctrl+, or the File menu.

Release Process

See .github/RELEASE.md for information about creating releases.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT License - see LICENSE file for details

Acknowledgments

• Built with Electron
• Markdown parsing by Marked
• Smart typography by marked-smartypants
• Monospace font: Fira Code

---

MDPX - Editors Shouldn't Be Complicated