Dillinger

Dillinger is a cloud-enabled, mobile-ready, offline-storage, AngularJS powered HTML5 Markdown editor.

• Type some Markdown on the left
• See HTML in the right
• Magic

Markdown is a lightweight markup language based on the formatting conventions that people naturally use in email. As John Gruber writes on the Markdown site

The overriding design goal for Markdown's formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it's been marked up with tags or formatting instructions.

This text you see here is actually written in Markdown! To get a feel for Markdown's syntax, type some text into the left window and watch the results in the right.

Version

3.2.7

Tech

Dillinger uses a number of open source projects to work properly:

• AngularJS - HTML enhanced for web apps!
• Ace Editor - awesome web-based text editor
• Marked - a super fast port of Markdown to JavaScript
• Twitter Bootstrap - great UI boilerplate for modern web apps
• node.js - evented I/O for the backend
• Express - fast node.js network app framework @tjholowaychuk
• Gulp - the streaming build system
• keymaster.js - awesome keyboard handler lib by @thomasfuchs
• jQuery - duh

And of course Dillinger itself is open source with a public repository on GitHub.

Installation

You need Gulp installed globally:

$ npm i -g gulp

$ git clone [git-repo-url] dillinger
$ cd dillinger
$ npm i -d
$ mkdir -p downloads/files/{md,html,pdf}
$ gulp build --prod
$ NODE_ENV=production node app

Running locally

Click the button bellow to quickly and safely install this project on your local machine.

The Run Project button employs azk, a lightweight open source orchestration tool that will automatically isolate and configure the application's environment for you.

Learn more about azk here.

Deploying to DigitalOcean

After you run this project locally using Run Project button, deploying to DigitalOcean is very simple.

First, be sure you have SSH keys configured in your machine. If you don't have it yet (or if you aren't sure about it), just follow steps 1 and 2 of this tutorial.

Next, put your personal access token into a .env file:

$ cd path/to/the/project
$ echo "DEPLOY_API_TOKEN=<YOUR-PERSONAL-ACCESS-TOKEN>" >> .env

Then, just run the following:

$ azk deploy

The Run Project button employs azk, a lightweight open source orchestration tool that will automatically isolate and configure the application's environment for you.

Find instructions for further resources (mostly customizations) to deploy to DigitalOcean using azk here.

Plugins

Dillinger is currently extended with the following plugins

• Dropbox
• Github
• Google Drive
• OneDrive

Readmes, how to use them in your own application can be found here:

• [plugins/dropbox/README.md] PlDb
• [plugins/github/README.md] PlGh
• [plugins/googledrive/README.md] PlGd
• [plugins/onedrive/README.md] PlOd

Development

Want to contribute? Great!

Dillinger uses Gulp + Webpack for fast developing. Make a change in your file and instantanously see your updates!

Open your favorite Terminal and run these commands.

First Tab:

$ node app

Second Tab:

$ gulp watch

(optional) Third:

$ karma start

Docker, N|Solid and NGINX

More details coming soon.

docker-compose.yml

Change the path for the nginx conf mounting path to your full path, not mine!

Todos

• Write Tests
• Rethink Github Save
• Add Code Comments
• Add Night Mode

License

MIT

Free Software, Hell Yeah!