Skip to content

pumpCurry/mdpad

Repository files navigation

Japanese 🇯🇵 日本語はこちら.

mdpad icon

mdpad

A GitHub-flavored Markdown editor built as a Windows standalone desktop application.
Edit, preview, and diff your Markdown files with a clean, multi-pane interface.

mdpad Editor and Preview

Features

  • Multi-pane layout -- switch between Editor, Preview, and Diff views (1-3 panes)
  • GitHub-flavored Markdown -- full GFM rendering with task lists and footnotes
  • Mermaid diagrams -- render flowcharts, sequence diagrams, and more
  • KaTeX math -- inline and display math expressions
  • Syntax-highlighted code blocks -- powered by highlight.js
  • Search and replace -- in-editor find with match count display
  • Global search -- cross-pane search across editor and preview
  • Drag-and-drop -- open files by dropping them onto the window
  • Autosave backup -- configurable timer with countdown display in status bar
  • Crash recovery -- restore your work after unexpected exits
  • HTML dialogs -- custom close and save confirmation dialogs with resume support
  • Zoom control -- zoom in/out with level displayed in status bar
  • Internationalization -- English and Japanese (en/ja)

Installation

Portable (recommended)

  1. Download the latest .zip from Releases.
  2. Extract to any folder.
  3. Run mdpad.exe.

No installation required.

Build from source

See the Development section below.

Keyboard Shortcuts

Shortcut Action
Ctrl+N New file
Ctrl+O Open file
Ctrl+S Save
Ctrl+Shift+S Save As
Ctrl+F Find
Ctrl+H Replace
Ctrl+1 / Ctrl+2 / Ctrl+3 Toggle panes
Alt+Z Word wrap
Ctrl+Z Undo
Ctrl+Y Redo
Ctrl++ / Ctrl+- Zoom in / out
Ctrl+0 Reset zoom
F12 DevTools

Development

Prerequisites

Setup

git clone https://github.com/pumpCurry/mdpad.git
cd mdpad
npm install

Run

npm start

For development mode with DevTools:

npm run dev

Build

Build a portable directory:

npm run build

Build and create a zip archive:

npm run build:zip

Tech Stack

Component Library License
Application framework Electron MIT
Code editor CodeMirror 6 MIT
Markdown parser markdown-it MIT
Diagrams Mermaid MIT
Math rendering KaTeX MIT
Syntax highlighting highlight.js BSD-3-Clause
Diff engine jsdiff BSD-3-Clause
HTML sanitizer DOMPurify Apache-2.0 / MPL-2.0
Markdown styles github-markdown-css MIT
Bundler esbuild MIT
Packager electron-builder MIT

Third-party Licenses

This project uses the following open-source libraries:

  • Electron -- MIT License
  • CodeMirror 6 -- MIT License
  • markdown-it -- MIT License
  • Mermaid -- MIT License
  • KaTeX -- MIT License
  • highlight.js -- BSD-3-Clause License
  • jsdiff -- BSD-3-Clause License
  • DOMPurify -- Apache-2.0 / MPL-2.0 License
  • github-markdown-css -- MIT License
  • esbuild -- MIT License
  • electron-builder -- MIT License

Documentation

License

MIT License. See LICENSE for details.

(C) pumpCurry, 5r4ce2

About

GitHub-flavored Markdown editor with live preview and diff

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors