Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dvcrn/markright
➡ Electron powered markdown editor with live preview
https://github.com/dvcrn/markright
Last synced: 4 days ago
JSON representation
➡ Electron powered markdown editor with live preview
- Host: GitHub
- URL: https://github.com/dvcrn/markright
- Owner: dvcrn
- License: gpl-3.0
- Created: 2015-10-12T10:08:36.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-11-30T00:57:18.000Z (about 3 years ago)
- Last Synced: 2025-01-08T09:04:17.717Z (11 days ago)
- Language: Clojure
- Homepage:
- Size: 1.91 MB
- Stars: 911
- Watchers: 24
- Forks: 55
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- my-awesome-github-stars - dvcrn/markright - ➡ Electron powered markdown editor with live preview (Clojure)
- awesome-markdown - MarkRight - Minimalistic github flavored Markdown editor. ![Mac OS X][macosx] ![Linux][linux] ![Windows][windows] (Tools / Editors)
- awesome-electron - MarkRight - GitHub flavored Markdown editor with live preview. (Apps / Open Source)
- awesome-electron-zh - MarkRight - GitHub flavored Markdown editor with live preview. (Apps / Open Source)
- awesome-electron - MarkRight - GitHub flavored Markdown editor with live preview.  (Apps / Markdown)
- awesomeelectron - MarkRight - GitHub flavored Markdown editor with live preview. (Apps / Open Source)
- awesome-starred - dvcrn/markright - ➡ Electron powered markdown editor with live preview (others)
README
_This project is currently frozen. If you want to help developing it, please feel free to [ping me](https://github.com/dvcrn)_
a minimalistic github flavored markdown editor
## Download
On mac, install it through [cask][8]:
```
brew install --cask markright
```
Alternatively, check out the [latest release][1] to quickly find the latest version.
Here are the current binaries:
- [Mac][2]
- [Windows 32bit][3]
- [Windows 64bit][4]
- [Linux ia32][5]
- [Linux x64][6]
### Command line
On mac, you can launch markright from the command line with a little alias:
```
alias markright="open -a /Applications/MarkRight.app"
markright README.md
```
## Building
MarkRight is written in clojurescript. To build, make sure you have clojure and leiningen installed on your system.
### Requirements
- `npm`
- `leiningen`
- `bower`
- `npm install`
- `bower install`
### Compiling
All commands you need are available inside `package.json`. To compile the code, run `npm run compile:`. `node/` is the folder that goes into electron.
### Development
To develop, run the self-reloading build:
- `lein run -m build/ui-dev`
- `lein run -m build/main-dev`
shadow-build will live-reload the frontend so you don't need to refresh. If you change `main.cljs` however, you'll have to restart electron to reload your changes.
## License
Licensed under [GPLv3][7]
[1]: https://github.com/dvcrn/markright/releases/latest/
[2]: https://github.com/dvcrn/markright/releases/download/0.1.11/MarkRight_Mac.dmg
[3]: https://github.com/dvcrn/markright/releases/download/0.1.11/MarkRight_Windows32.exe
[4]: https://github.com/dvcrn/markright/releases/download/0.1.11/MarkRight_Windows64.exe
[5]: https://github.com/dvcrn/markright/releases/download/0.1.11/MarkRight_Linux_ia32.zip
[6]: https://github.com/dvcrn/markright/releases/download/0.1.11/MarkRight_Linux_x64.zip
[7]: http://www.gnu.org/licenses/gpl-3.0.txt
[8]: http://caskroom.io/