Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/joemccann/dillinger

The last Markdown editor, ever.
https://github.com/joemccann/dillinger

blog blogging editor ide javascript markdown md node nodejs writing

Last synced: 19 days ago
JSON representation

The last Markdown editor, ever.

Awesome Lists containing this project

README 

        
# Dillinger

## _The Last Markdown Editor, Ever_



[![N|Solid](https://cldup.com/dTxpPi9lDf.thumb.png)](https://nodesource.com/products/nsolid)



[![Build Status](https://travis-ci.org/joemccann/dillinger.svg?branch=master)](https://travis-ci.org/joemccann/dillinger)



Dillinger is a cloud-enabled, mobile-ready, offline-storage compatible,

AngularJS-powered HTML5 Markdown editor.



- Type some Markdown on the left

- See HTML in the right

- ✨Magic ✨



## Features



- Import a HTML file and watch it magically convert to Markdown

- Drag and drop images (requires your Dropbox account be linked)

- Import and save files from GitHub, Dropbox, Google Drive and One Drive

- Drag and drop markdown and HTML files into Dillinger

- Export documents as Markdown, HTML and PDF



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][df1]



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



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

- [markdown-it] - Markdown parser done right. Fast and easy to extend.

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

- [Breakdance](https://breakdance.github.io/breakdance/) - HTML

to Markdown converter

- [jQuery] - duh



And of course Dillinger itself is open source with a [public repository][dill]

 on GitHub.



## Installation



Dillinger requires [Node.js](https://nodejs.org/) v10+ to run.



Install the dependencies and devDependencies and start the server.



```sh

cd dillinger

npm i

node app

```



For production environments...



```sh

npm install --production

NODE_ENV=production node app

```



## Plugins



Dillinger is currently extended with the following plugins.

Instructions on how to use them in your own application are linked below.



| Plugin | README |

| ------ | ------ |

| Dropbox | [plugins/dropbox/README.md][PlDb] |

| GitHub | [plugins/github/README.md][PlGh] |

| Google Drive | [plugins/googledrive/README.md][PlGd] |

| OneDrive | [plugins/onedrive/README.md][PlOd] |

| Medium | [plugins/medium/README.md][PlMe] |

| Google Analytics | [plugins/googleanalytics/README.md][PlGa] |



## Development



Want to contribute? Great!



Dillinger uses Gulp + Webpack for fast developing.

Make a change in your file and instantaneously see your updates!



Open your favorite Terminal and run these commands.



First Tab:



```sh

node app

```



Second Tab:



```sh

gulp watch

```



(optional) Third:



```sh

karma test

```



#### Building for source



For production release:



```sh

gulp build --prod

```



Generating pre-built zip archives for distribution:



```sh

gulp build dist --prod

```



## Docker



Dillinger is very easy to install and deploy in a Docker container.



By default, the Docker will expose port 8080, so change this within the

Dockerfile if necessary. When ready, simply use the Dockerfile to

build the image.



```sh

cd dillinger

docker build -t /dillinger:${package.json.version} .

```



This will create the dillinger image and pull in the necessary dependencies.

Be sure to swap out `${package.json.version}` with the actual

version of Dillinger.



Once done, run the Docker image and map the port to whatever you wish on

your host. In this example, we simply map port 8000 of the host to

port 8080 of the Docker (or whatever port was exposed in the Dockerfile):



```sh

docker run -d -p 8000:8080 --restart=always --cap-add=SYS_ADMIN --name=dillinger /dillinger:${package.json.version}

```



> Note: `--cap-add=SYS_ADMIN` is required for PDF rendering.



Verify the deployment by navigating to your server address in

your preferred browser.



```sh

127.0.0.1:8000

```



## License



MIT



**Free Software, Hell Yeah!**



[//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen. Thanks SO - http://stackoverflow.com/questions/4823468/store-comments-in-markdown-syntax)



   [dill]: 

   [git-repo-url]: 

   [john gruber]: 

   [df1]: 

   [markdown-it]: 

   [Ace Editor]: 

   [node.js]: 

   [Twitter Bootstrap]: 

   [jQuery]: 

   [@tjholowaychuk]: 

   [express]: 

   [AngularJS]: 

   [Gulp]: 



   [PlDb]: 

   [PlGh]: 

   [PlGd]: 

   [PlOd]: 

   [PlMe]: 

   [PlGa]: