{"id":13765720,"url":"https://github.com/steventhanna/proton","last_synced_at":"2025-08-20T22:31:23.974Z","repository":{"id":2751098,"uuid":"43589503","full_name":"steventhanna/proton","owner":"steventhanna","description":"A stand-alone application to quickly preview and edit Markdown files using Electron. ","archived":false,"fork":false,"pushed_at":"2023-01-06T18:43:03.000Z","size":420836,"stargazers_count":160,"open_issues_count":21,"forks_count":20,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-04-14T22:19:56.576Z","etag":null,"topics":["electron","markdown","markdown-editor","markdown-parser","proton","text-editor"],"latest_commit_sha":null,"homepage":"http://steventhanna.github.io/proton","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/steventhanna.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"license.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-10-03T05:55:18.000Z","updated_at":"2024-03-14T08:47:00.000Z","dependencies_parsed_at":"2023-01-11T16:12:15.191Z","dependency_job_id":null,"html_url":"https://github.com/steventhanna/proton","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steventhanna%2Fproton","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steventhanna%2Fproton/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steventhanna%2Fproton/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/steventhanna%2Fproton/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/steventhanna","download_url":"https://codeload.github.com/steventhanna/proton/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230462906,"owners_count":18229864,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["electron","markdown","markdown-editor","markdown-parser","proton","text-editor"],"created_at":"2024-08-03T16:00:44.581Z","updated_at":"2024-12-19T16:11:13.732Z","avatar_url":"https://github.com/steventhanna.png","language":"JavaScript","readme":"[![Stories in Ready](https://badge.waffle.io/steventhanna/proton.png?label=ready\u0026title=Ready)](https://waffle.io/steventhanna/proton)\n# Proton\nA stand-alone application to quickly preview and edit Markdown files using Electron.\n\n![Proton Screenshot](http://steventhanna.github.io/proton/proton-image.png)\n\n## Purpose\nAs 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).\n\n## Installing\n### Mac OS X\n1. Download the [Zip File](https://github.com/steventhanna/proton/releases/download/v0.1.0/Proton-OSX.zip).\n2. Unzip the file.\n3. Move `Proton.app` to your Applications Folder.\n\n### Windows\n1. Download the [Zip File](https://github.com/steventhanna/proton/releases/download/v0.1.0/Proton-Windows.zip).\n2. Unzip the file.\n3. Move the `Proton.exe` to your desired destination for installed applications.\n\n### Linux\n#### Ubuntu (From PPA)\n_Coming soon_\n\n#### Ubuntu (.deb)\n1. 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_)\n    ```\n    $: cd ~/Downloads\n    $: wget https://github.com/steventhanna/proton/releases/download/v0.1.0/proton_0.1.0_amd64.deb\n    ```\n2. Install Proton from the .deb file.\n    ```\n    $: sudo dpkg -i proton_0.1.0_amd64.deb\n    ```\n\n#### Linux (Binary)\n1. 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))\n    ```\n    $: cd ~/Download\n\n    # For x64\n    $: wget https://github.com/steventhanna/proton/releases/download/v0.1.0/Proton-Linux_0.1.0_x64.tar.gz\n    $: tar -xzf Proton-Linux_0.1.0_x64.tar.gz\n    $: mkdir /opt/Proton\n    $: cd /opt/Proton\n    $: mv ~/Downloads/Proton-Linux_0.1.0_x64/* .\n\n    # For ia32\n    $: wget https://github.com/steventhanna/proton/releases/download/v0.1.0/Proton-Linux_0.1.0_ia32.tar.g\n    $: tar -xzf Proton-Linux_0.1.0_ia32.tar.gz\n    $: mkdir /opt/Proton\n    $: cd /opt/Proton\n    $: mv ~/Downloads/Proton-Linux_0.1.0_ia32/* .\n    ```\n\n## Building\n1. Clone repo: `git clone git@github.com:steventhanna/proton.git`\n2. Change to repo: `cd PATH$TO$REPO`\n3. Install dependencies: `npm install`\n\n### Usage\n1. Start electron: `electron .`\n\n## Tests\n_Coming Soon_\n\n## Contributing\n1. Fork it!\n2. Create your feature branch: `git checkout my-new-feature`\n3. Commit your changes\n4. Submit a pull request\n\n## License\nProton is licensed under the GNU General Public License.  Read the license [here](https://github.com/steventhanna/proton/blob/master/license).\n\n## Built On\n- [Electron](https://github.com/atom/electron)\n- [Bootstrap](http://getbootstrap.com)\n- [Marked.js](https://github.com/chjj/marked)\n- [Ace Editor](http://ace.c9.io/#nav=about)\n- [Hack Typeface](https://github.com/chrissimpkins/Hack)\n- [html-pdf](https://github.com/marcbachmann/node-html-pdf)\n\n**CoverAll Package Script:** `electron-packager proton Proton --platform=linux --arch=all --overwrite \u0026\u0026 electron-packager proton Proton --platform=win32 --arch=all --icon=proton.ico --overwrite \u0026\u0026 electron-packager proton Proton --platform=darwin --arch=all --icon=proton.icns --overwrite`\n","funding_links":[],"categories":["Apps"],"sub_categories":["Markdown","Open Source"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsteventhanna%2Fproton","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsteventhanna%2Fproton","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsteventhanna%2Fproton/lists"}