You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
New Features!
Import a HTML file and watch it magically convert to Markdown
Drag and drop images (requires your Dropbox account be linked)
You can also:
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
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:
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 test
Building for source
For production release:
$ gulp build --prod
Generating pre-built zip archives for distribution:
$ 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.
cd dillinger
docker build -t joemccann/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):
docker run -d -p 8000:8080 --restart="always"<youruser>/dillinger:${package.json.version}
Verify the deployment by navigating to your server address in your preferred browser.
GitLab uses "GitLab Flavored Markdown" (GFM). It extends the standard Markdown in a few significant ways to add some useful functionality. It was inspired by GitHub Flavored Markdown.
You can use GFM in the following areas:
comments
issues
merge requests
milestones
snippets (the snippet must be named with a .md extension)
wiki pages
markdown documents inside the repository
You can also use other rich text files in GitLab. You might have to install a
dependency to do so. Please see the github-markup gem readme for more information.
A paragraph is simply one or more consecutive lines of text, separated by one or more blank lines.
Line-breaks, or softreturns, are rendered if you end a line with two or more spaces:
Roses are red [followed by two or more spaces]
Violets are blue
Sugar is sweet
It is not reasonable to italicize just part of a word, especially when you're dealing with code and names that often appear with multiple underscores. Therefore, GFM ignores multiple underscores in words:
GitLab uses the Rouge Ruby library for syntax highlighting. For a
list of supported languages visit the Rouge website.
Blocks of code are either fenced by lines with three back-ticks ```,
or are indented with four spaces. Only the fenced code blocks support syntax
highlighting:
Inline `code` has `back-ticks around` it.
Inline code has back-ticks around it.
Example:
```javascript
var s = "JavaScript syntax highlighting";
alert(s);
```
```python
def function():
#indenting works just fine in the fenced code block
s = "Python syntax highlighting"
print s
```
```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```
```
No language indicated, so no syntax highlighting.
s = "There is no highlighting for this."
But let's throw in a <b>tag</b>.
```
becomes:
vars="JavaScript syntax highlighting";alert(s);
deffunction():
#indenting works just fine in the fenced code blocks="Python syntax highlighting"prints
Sometimes you want to :monkey: around a bit and add some :star2: to your :speech_balloon:. Well we have a gift for you:
:zap: You can use emoji anywhere GFM is supported. :v:
You can use it to point out a :bug: or warn about :speak_no_evil: patches. And if someone improves your really :snail: code, send them some :birthday:. People will :heart: you for that.
If you are new to this, don't be :fearful:. You can easily join the emoji :family:. All you need to do is to look up on the supported codes.
Consult the [Emoji Cheat Sheet](http://emoji.codes) for a list of all supported emoji codes. :thumbsup:
Sometimes you want to 🐒 around a bit and add some 🌟 to your 💬. Well we have a gift for you:
⚡ You can use emoji anywhere GFM is supported. ✌️
You can use it to point out a 🐛 or warn about 🙊 patches. And if someone improves your really 🐌 code, send them some 🎂. People will ❤️ you for that.
If you are new to this, don't be 😨. You can easily join the emoji 👪. All you need to do is to look up on the supported codes.
Consult the Emoji Cheat Sheet for a list of all supported emoji codes. 👍
Special GitLab References
GFM recognizes special references.
You can easily reference e.g. an issue, a commit, a team member or even the whole team within a project.
GFM will turn that reference into a link so you can navigate between them easily.
GFM will recognize the following:
input
references
@user_name
specific user
@group_name
specific group
@all
entire team
#123
issue
!123
merge request
$123
snippet
~123
label by ID
~bug
one-word label by name
~"feature request"
multi-word label by name
%123
project milestone by ID
%v1.23
one-word milestone by name
%"release candidate"
multi-word milestone by name
9ba12248
specific commit
9ba12248...b19a04f5
commit range comparison
[README](doc/README)
repository file references
[README](doc/README#L13)
repository file line references
GFM also recognizes certain cross-project references:
Task lists can only be created in descriptions, not in titles. Task item state can be managed by editing the description's Markdown or by toggling the rendered check boxes.
It is possible to have math written with the LaTeX syntax rendered using KaTeX.
Math written inside $``$ will be rendered inline with the text.
Math written inside triple back quotes, with the language declared as math, will be rendered on a separate line.
Example:
This math is inline $`a^2+b^2=c^2`$.
This is on a separate line
```math
a^2+b^2=c^2
```
Becomes:
This math is inline $a^2+b^2=c^2$.
This is on a separate line
$$a^2+b^2=c^2$$
Be advised that KaTeX only supports a subset of LaTeX.
Note:
This also works for the asciidoctor :stem: latexmath. For details see the asciidoctor user manual.
Standard Markdown
Headers
# H1
## H2
### H3
#### H4
##### H5
###### H6
Alternatively, for H1 and H2, an underline-ish style:
Alt-H1
======
Alt-H2
------
Header IDs and links
All Markdown-rendered headers automatically get IDs, except in comments.
On hover a link to those IDs becomes visible to make it easier to copy the link to the header to give it to someone else.
The IDs are generated from the content of the header according to the following rules:
All text is converted to lowercase
All non-word text (e.g., punctuation, HTML) is removed
All spaces are converted to hyphens
Two or more hyphens in a row are converted to one
If a header with the same ID has already been generated, a unique
incrementing number is appended, starting at 1.
For example:
# This header has spaces in it
## This header has a :thumbsup: in it
# This header has Unicode in it: 한글
## This header has spaces in it
### This header has spaces in it
Would generate the following link IDs:
this-header-has-spaces-in-it
this-header-has-a-in-it
this-header-has-unicode-in-it-한글
this-header-has-spaces-in-it
this-header-has-spaces-in-it-1
Note that the Emoji processing happens before the header IDs are generated, so the Emoji is converted to an image which then gets removed from the ID.
Emphasis
Emphasis, aka italics, with *asterisks* or _underscores_.
Strong emphasis, aka bold, with **asterisks** or __underscores__.
Combined emphasis with **asterisks and _underscores_**.
Strikethrough uses two tildes. ~~Scratch this.~~
Emphasis, aka italics, with asterisks or underscores.
Strong emphasis, aka bold, with asterisks or underscores.
Combined emphasis with asterisks and underscores.
Strikethrough uses two tildes. Scratch this.
Lists
1. First ordered list item
2. Another item
* Unordered sub-list.
1. Actual numbers don't matter, just that it's a number
1. Ordered sub-list
4. And another item.
* Unordered list can use asterisks
- Or minuses
+ Or pluses
First ordered list item
Another item
Unordered sub-list.
Actual numbers don't matter, just that it's a number
Ordered sub-list
And another item.
Unordered list can use asterisks
Or minuses
Or pluses
If a list item contains multiple paragraphs,
each subsequent paragraph should be indented with four spaces.
1. First ordered list item
Second paragraph of first item.
2. Another item
First ordered list item
Second paragraph of first item.
Another item
If the second paragraph isn't indented with four spaces,
the second list item will be incorrectly labeled as 1.
1. First ordered list item
Second paragraph of first item.
2. Another item
First ordered list item
Second paragraph of first item.
Another item
Links
There are two ways to create links, inline-style and reference-style.
[I'm an inline-style link](https://www.google.com)
[I'm a reference-style link][Arbitrary case-insensitive reference text]
[I'm a relative reference to a repository file](LICENSE)
[I am an absolute reference within the repository](/doc/user/markdown.md)
[I link to the Milestones page](/../milestones)
[You can use numbers for reference-style link definitions][1]
Or leave it empty and use the [link text itself][]
Some text to show that the reference links can follow later.
[arbitrary case-insensitive reference text]: https://www.mozilla.org
[1]: http://slashdot.org
[link text itself]: https://www.reddit.com
Note:
Relative links do not allow referencing project files in a wiki page or wiki
page in a project file. The reason for this is that, in GitLab, wiki is always
a separate Git repository. For example, [I'm a reference-style link](style)
will point the link to wikis/style when the link is inside of a wiki markdown file.
Images
Here's our logo (hover to see the title text):
Inline-style:
Reference-style:
![alt text1][logo]
[logo]: img/markdown_logo.png
Here's our logo:
Inline-style:
Reference-style:
Blockquotes
> Blockquotes are very handy in email to emulate reply text.
> This line is part of the same quote.
Quote break.
> This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can *put* **Markdown** into a blockquote.
Blockquotes are very handy in email to emulate reply text.
This line is part of the same quote.
Quote break.
This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can putMarkdown into a blockquote.
Inline HTML
You can also use raw HTML in your Markdown, and it'll mostly work pretty well.
See the documentation for HTML::Pipeline's SanitizationFilter class for the list of allowed HTML tags and attributes. In addition to the default SanitizationFilter whitelist, GitLab allows span, abbr, details and summary elements.
<dl>
<dt>Definition list</dt>
<dd>Is something people use sometimes.</dd>
<dt>Markdown in HTML</dt>
<dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd>
</dl>
Definition list
Is something people use sometimes.
Markdown in HTML
Does *not* work **very** well. Use HTML tags.
Details and Summary
Content can be collapsed using HTML's <details> and <summary> tags. This is especially useful for collapsing long logs so they take up less screen space.
Click me to collapse/fold.
These details will remain hidden until expanded.
PASTE LOGS HERE
Note: Unfortunately Markdown is not supported inside these tags, as described by the markdown specification. You can work around this by using HTML, for example you can use <pre><code> tags instead of code fences.
<details><summary>Click me to collapse/fold.</summary>
These details will remain hidden until expanded.
<pre><code>PASTE LOGS HERE</code></pre></details>
Horizontal Rule
Three or more...
---
Hyphens
***
Asterisks
___
Underscores
Three or more...
Hyphens
Asterisks
Underscores
Line Breaks
My basic recommendation for learning how line breaks work is to experiment and discover -- hit <Enter> once (i.e., insert one newline), then hit it twice (i.e., insert two newlines), see what happens. You'll soon learn to get what you want. "Markdown Toggle" is your friend.
Here are some things to try out:
Here's a line for us to start with.
This line is separated from the one above by two newlines, so it will be a *separate paragraph*.
This line is also a separate paragraph, but...
This line is only separated by a single newline, so it *does not break* and just follows the previous line in the *same paragraph*.
This line is also a separate paragraph, and...
This line is *on its own line*, because the previous line ends with two spaces. (but still in the *same paragraph*)
spaces.
Here's a line for us to start with.
This line is separated from the one above by two newlines, so it will be a separate paragraph.
This line is also a separate paragraph, but...
This line is only separated by a single newline, so it does not break and just follows the previous line in the same paragraph.
This line is also a separate paragraph, and...
This line is on its own line, because the previous line ends with two spaces. (but still in the same paragraph)
spaces.
Tables
Tables aren't part of the core Markdown spec, but they are part of GFM and Markdown Here supports them.
<details><summary>Click me to collapse/fold.</summary>
These details will remain hidden until expanded.
<pre><codecontentEditable>PASTE LOGS HERE</code></pre></details>
Click me to collapse/fold.
These details will remain hidden until expanded.
👋 :github: 
🍺 🐮 🇸🇰 🇺🇿 🤷