Markdown++

A minimal Markdown Editor desktop app built on top of Electron.

Key Features • How To Use • License

Key Features

• Git sync
  • menu->File->Git Config or (ctrl+shirt+c) can storing all document to a git prite repositories for you by git
• LivePreview - Make changes, See changes
  • Instantly see what your Markdown documents look like in HTML as you create them.
• Sync Scrolling
  • While you type, LivePreview will automatically scroll to the current location you're editing.
• GitHub Flavored Markdown
• Syntax highlighting
• KaTeX Support
• Dark/Light mode
• Toolbar for basic Markdown formatting
• Supports multiple cursors
• Save the Markdown preview as PDF
• Emoji support in preview :tada::smile:
• App will keep alive in tray for quick usage
• Full screen mode
  • Write distraction free.
• Cross platform
  • Windows, macOS and Linux ready.

How To Use

To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

# Clone this repository
$ git clone https://gitee.com/geliang/markdown.git

# Go into the repository
$ cd markdown

# Install dependencies
$ npm install

# Run the app
$ npm start


### release
Electron 应用开发完成之后，还需要将其打包成对应平台的客户端。常用的打包工具有 electron-packager 和 asar。

这里以 electron-packager 为例。
# 首先全局安装 electron-packager：

$ npm install electron-packager -g
# 然后在项目中安装 electron：

$ npm install electron --save-dev
# 然后打包：

$ electron-packager . Markdown

Note: If you're using Linux Bash for Windows, see this guide or use node from the command prompt.

Credits

This software uses following open source packages.

• Electron
• Node.js
• Marked - a markdown parser
• showdown
• CodeMirror
• Emojis are taken from here
• highlight.js

Support

License

MIT

erdange.com  @  geliang0120@gmail.com