MdEdit

MdEdit is a minimalist Markdown editor that lets you write Markdown files with a live preview and otherwise stays out of your way.

MdEdit supports relative image paths, as well as defining image size via the title. See Features for more details.

Features

• Relative image paths
• Synchronized scrolling between editor and preview
• Standard keyboard shortcuts (substitute Cmd for Ctrl on Mac)
  • Ctrl+s to save
  • Ctrl+n for new file
  • Ctrl+o to open a file
• Image size setting in title
  • e.g. ![Alt Text](./path/to/image.png "128x128")
  • If not set, the image will be limited to 100% width
• Checklists
  • Just like GitHub - [ ] ToDo is unchecked, and - [x] Done is checked
  • Visual only - not interactive

Settings

There are just a few options in the Settings. The status bar shows the path to the current file, and whether there are unsaved changes.

Including a dark theme.

Building

• Clone the repo: git clone https://github.com/kiswa/MdEdit
• Install dependencies: npm i
• Build it: npm run electron:build

Development

MdEdit uses Electron and Vue.js.

If you want to develop for MdEdit it's very simple:

• Clone the repo: git clone https://github.com/kiswa/MdEdit
• Install dependencies: npm i
• Run it: npm run electron:serve

NB: The releases are built using Font Awesome Pro icons. If you have a license - and have npm set up for it - your local builds will use these icons. If not, you will get errors.

Thanks To:

In addition to Electron and Vue.js, MdEdit is built with the following open-source projects:

• marked - Fast Markdown parsing
• highlight.js - Code highlighting
• Font Awesome - Icons
• Source Code Pro and Source Sans Pro - Fonts