Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
The last Markdown editor, ever.
JavaScript CSS HTML
branch: master

Merge pull request #317 from Peter-Schneider/issues/302

Fixes #302: Correction of the links in the README.md file
latest commit ea040bf681
@joemccann authored

README.md

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] [1]:

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

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 public/files/{md,html,pdf}
$ gulp build --prod
$ NODE_ENV=production node app

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:

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

Todos

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

License

MIT

Free Software, Hell Yeah!

Something went wrong with that request. Please try again.