Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/steventhanna/proton
A stand-alone application to quickly preview and edit Markdown files using Electron.
https://github.com/steventhanna/proton
electron markdown markdown-editor markdown-parser proton text-editor
Last synced: 29 days ago
JSON representation
A stand-alone application to quickly preview and edit Markdown files using Electron.
- Host: GitHub
- URL: https://github.com/steventhanna/proton
- Owner: steventhanna
- License: gpl-3.0
- Created: 2015-10-03T05:55:18.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T18:43:03.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T22:19:56.576Z (7 months ago)
- Topics: electron, markdown, markdown-editor, markdown-parser, proton, text-editor
- Language: JavaScript
- Homepage: http://steventhanna.github.io/proton
- Size: 401 MB
- Stars: 160
- Watchers: 6
- Forks: 20
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: license.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-electron - Proton - Markdown editor with live preview. (Apps / Open Source)
- awesome-electron-zh - Proton - Markdown editor with live preview. (Apps / Open Source)
- awesome-electron - Proton - Markdown editor with live preview.  (Apps / Markdown)
README
[](https://waffle.io/steventhanna/proton)
# Proton
A stand-alone application to quickly preview and edit Markdown files using Electron.
## Purpose
As a college student, I needed a way to quickly take rich notes in class. I have long been a proponent of the Markdown Language, so I decided to download [MacDown](http://macdown.uranusjr.com/) for easy rendering and viewing. However, upon an OS update on my local machine, the Markdown rendering broke. Thus, I decided to build my own open-sourced version that is supported on Windows, OSX, and Linux machines using the [Electron Framework](https://github.com/atom/electron).
## Installing
### Mac OS X
1. Download the [Zip File](https://github.com/steventhanna/proton/releases/download/v0.1.0/Proton-OSX.zip).
2. Unzip the file.
3. Move `Proton.app` to your Applications Folder.
### Windows
1. Download the [Zip File](https://github.com/steventhanna/proton/releases/download/v0.1.0/Proton-Windows.zip).
2. Unzip the file.
3. Move the `Proton.exe` to your desired destination for installed applications.
### Linux
#### Ubuntu (From PPA)
_Coming soon_
#### Ubuntu (.deb)
1. Download the [.deb file](https://github.com/steventhanna/proton/releases/download/v0.1.0/proton_0.1.0_amd64.deb) (amd64 only -- _more support coming soon_)
```
$: cd ~/Downloads
$: wget https://github.com/steventhanna/proton/releases/download/v0.1.0/proton_0.1.0_amd64.deb
```
2. Install Proton from the .deb file.
```
$: sudo dpkg -i proton_0.1.0_amd64.deb
```
#### Linux (Binary)
1. Download and Install the Binary. ([x64](https://github.com/steventhanna/proton/releases/download/v0.1.0/Proton-Linux_0.1.0_x64.tar.gz)) ([ia32](https://github.com/steventhanna/proton/releases/download/v0.1.0/Proton-Linux_0.1.0_ia32.tar.gz))
```
$: cd ~/Download
# For x64
$: wget https://github.com/steventhanna/proton/releases/download/v0.1.0/Proton-Linux_0.1.0_x64.tar.gz
$: tar -xzf Proton-Linux_0.1.0_x64.tar.gz
$: mkdir /opt/Proton
$: cd /opt/Proton
$: mv ~/Downloads/Proton-Linux_0.1.0_x64/* .
# For ia32
$: wget https://github.com/steventhanna/proton/releases/download/v0.1.0/Proton-Linux_0.1.0_ia32.tar.g
$: tar -xzf Proton-Linux_0.1.0_ia32.tar.gz
$: mkdir /opt/Proton
$: cd /opt/Proton
$: mv ~/Downloads/Proton-Linux_0.1.0_ia32/* .
```
## Building
1. Clone repo: `git clone [email protected]:steventhanna/proton.git`
2. Change to repo: `cd PATH$TO$REPO`
3. Install dependencies: `npm install`
### Usage
1. Start electron: `electron .`
## Tests
_Coming Soon_
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout my-new-feature`
3. Commit your changes
4. Submit a pull request
## License
Proton is licensed under the GNU General Public License. Read the license [here](https://github.com/steventhanna/proton/blob/master/license).
## Built On
- [Electron](https://github.com/atom/electron)
- [Bootstrap](http://getbootstrap.com)
- [Marked.js](https://github.com/chjj/marked)
- [Ace Editor](http://ace.c9.io/#nav=about)
- [Hack Typeface](https://github.com/chrissimpkins/Hack)
- [html-pdf](https://github.com/marcbachmann/node-html-pdf)
**CoverAll Package Script:** `electron-packager proton Proton --platform=linux --arch=all --overwrite && electron-packager proton Proton --platform=win32 --arch=all --icon=proton.ico --overwrite && electron-packager proton Proton --platform=darwin --arch=all --icon=proton.icns --overwrite`