https://github.com/tbreuss/asciitron
:hospital: AsciiDoc Editor built with Electron and Asciidoctor.js.
https://github.com/tbreuss/asciitron
asciidoc asciidoctor desktop-app editor electron electron-app hacktoberfest
Last synced: 3 days ago
JSON representation
:hospital: AsciiDoc Editor built with Electron and Asciidoctor.js.
- Host: GitHub
- URL: https://github.com/tbreuss/asciitron
- Owner: tbreuss
- License: cc0-1.0
- Created: 2017-02-18T14:43:47.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-02-03T10:26:46.000Z (over 2 years ago)
- Last Synced: 2025-05-03T20:35:43.268Z (5 months ago)
- Topics: asciidoc, asciidoctor, desktop-app, editor, electron, electron-app, hacktoberfest
- Language: JavaScript
- Homepage:
- Size: 13 MB
- Stars: 11
- Watchers: 3
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Asciitron
Asciitron is a simple Desktop [AsciiDoc](https://asciidoctor.org/docs/what-is-asciidoc/) Editor built with [Electron](https://electronjs.org) and [Asciidoctor.js](https://asciidoctor.org/docs/asciidoctor.js/).
## Prerequisites
- Git (https://git-scm.com)
- NPM (https://www.npmjs.com)
## Third Party Software
- [Ace (Ajax.org Cloud9 Editor)](https://ace.c9.io/)
- [Asciidoctor.js](https://asciidoctor.org/docs/asciidoctor.js/)
- [Asciidoctor Stylesheet Factory](https://github.com/asciidoctor/asciidoctor-stylesheet-factory)
- [Electron](https://www.electronjs.org/)
- [Highlight.js](https://highlightjs.org/)
- [Photon](http://photonkit.com/)
## Development
Clone this repository
~~~bash
git clone https://github.com/tbreuss/asciitron.git
~~~
Go into the repository
~~~bash
cd asciitron
~~~
Install dependencies
~~~bash
npm install
~~~
Run the app
~~~bash
npm start
~~~
## Build & Release
Build the application for Mac, Windows and Linux using Electron Builder.
~~~bash
npm run release
~~~
Build and release the application on Github Releases.
```bash
GH_TOKEN=MY_GITHUB_TOKEN npm run release
```
## License
[CC0 1.0 (Public Domain)](LICENSE.md)
## Suggestions
Any suggestions? Open an issue.