Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vesparny/marky
A markdown editor built with Electron and React
https://github.com/vesparny/marky
app application electron markdown markdown-editor osx react
Last synced: about 1 month ago
JSON representation
A markdown editor built with Electron and React
- Host: GitHub
- URL: https://github.com/vesparny/marky
- Owner: vesparny
- License: mit
- Archived: true
- Created: 2015-09-01T00:05:26.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-09-04T17:11:55.000Z (about 6 years ago)
- Last Synced: 2024-09-25T21:15:25.595Z (about 1 month ago)
- Topics: app, application, electron, markdown, markdown-editor, osx, react
- Language: JavaScript
- Homepage:
- Size: 4.05 MB
- Stars: 355
- Watchers: 12
- Forks: 41
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-electron-zh - Marky - Markdown editor. (Apps / Open Source)
- awesome-electron - Marky - Markdown editor.  (Apps / Markdown)
README
Marky
A Markdown editor
For OS X, Windows and Linux
Built with Electron and React + Redux
## Install
**Marky** is still under development. You can download the latest version from the [releases](https://github.com/vesparny/marky/releases) page.
Please not that binaries are not signed. If you need them to be signed you can easily do it with your own certificates.
## 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](https://github.com/electron/electron)
* [React](https://facebook.github.io/react/)
* [Redux](https://github.com/reactjs/redux/)
## Roadmap
Refer to open [issues](https://github.com/vesparny/marky/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.
```bash
$ npm run build
```
To build for one platform:
```bash
$ 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](https://www.winehq.org/) needs
to be installed.
On OS X, first install [XQuartz](http://www.xquartz.org/), then run:
```
brew install wine
```
(Requires the [Homebrew](http://brew.sh/) package manager.)
### Code Style
[](https://github.com/feross/standard)
## Inspiration
* https://github.com/feross/webtorrent-desktop (the build script has been basically copy-pasted from there)
* https://github.com/chentsulin/electron-react-boilerplate
## License
MIT. Copyright (c) [Alessandro Arnodo](https://alessandro.arnodo.net).