illiptic/marky

A markdown editor built with Electron and React

Marky

A Markdown editor

For OS X (Windows, and Linux soon)

Built with Electron and React + Redux

Install

Marky is still under development. You can download the latest version from the releases page.

Features

• Live preview
• GitHub Flavored Markdown support
• Search in Markdown
• Syntax highlighting
• Emoji Support
• Words count
• Resizable panels
• Finder integration (OS X)

Technologies used

• electron
• React
• Redux

Roadmap

Refer to open issues. Also feel free to propose features and report bugs.

How to Contribute

Install dependencies

$ npm install

Run app

$ npm start

Package app

Builds app binaries for OS X, Linux, and Windows.

$ npm run build

To build for one platform:

$ npm run build -- [platform]

Where [platform] is darwin, linux, win32, or all (default).

The following optional arguments are available:

• --sign - Sign the application (OS X, Windows)
• --package=[type] - Package single output type.
  • deb - Debian package
  • zip - Linux zip file
  • dmg - OS X disk image
  • exe - Windows installer
  • portable - Windows portable app
  • all - All platforms (default)

Note: Even with the --package option, the auto-update files (.nupkg for Windows, *-darwin.zip for OS X) will always be produced.

Windows build notes

To package the Windows app from non-Windows platforms, Wine needs to be installed.

On OS X, first install XQuartz, then run:

brew install wine

(Requires the Homebrew package manager.)

Code Style

License

MIT. Copyright (c) Alessandro Arnodo.