Dark Mode

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

steventhanna/proton

Repository files navigation

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 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.

Installing

Mac OS X

  1. Download the Zip File.
  2. Unzip the file.
  3. Move Proton.app to your Applications Folder.

Windows

  1. Download the Zip File.
  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 (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) (ia32)
    $: 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 git@github.com: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.

Built On

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

About

A stand-alone application to quickly preview and edit Markdown files using Electron.

Topics

Resources

Readme

License

GPL-3.0 license

Code of conduct

Code of conduct

Contributing

Contributing

Stars

Watchers

Forks

Packages

Contributors