TYPEMILL

Markdown

Never heard of Markdown? Markdown is very similar to the markup used by Wikipedia. It is a simple syntax to format headlines, lists or paragraphs in a text file. Markdown files end with .md.

Today, Markdown is a standard formatting language used by a lot of technology platforms like GitHub or StackOverflow. And Markdown is also entering the non technical mainstream. The press releases of dpa are written in Markdown, for example.

Markdown uses some special chars like # or - to format a text. A short example:

# My first level headline

This is a paragraph and now we create an unordered list:

- Item
- Another item
- A last item

Advantages of Markdown

There are some good reasons for the rise of Markdown:

There are also some disadvantages:

With the following basic Markdown reference, you can learn to write Markdown in less than 10 minutes!

Basic Markdown Reference

You can read the full specification of Markdown at Mark Guber, the inventor of Markdown.

Paragraph

Just write down some text and use the return key two times for a new paragraph:

To create a new paragraph, just press the return button two times.

Then proceed writing. It is really as simple as that!

Emphasis and Strong

Embed text in a _ or * to create an emphasis or use a __ or ** to create strong text element:

This is an _emphasis_ and this is a __strong__ text. 

You can use asterix for an *emphasis* or a **strong** text, too.

Headlines

Just use the character # for headlines like this:

# Headline (1. level)
## Headline (2. level)
### Headline (3. level)
#### Headline (4. level)
##### Headline (5. level)
###### Headline (6. level)

Lists

To create an unordered - or ordered 1. list, just follow your intuition:

This is an unordered list: 

- Item
- Another item
- Last item

And this is an ordred list: 

1. Item 1
2. Item 2
3. Item 3

Blockquote

Just use the > to create a blockquote:

This is a quote by a famous woman:

> If I stop to kick every barking dog I am not going to get where I’m going.

Horizontal Rule

To create a horizontal line, use ---

This is a text followed by a horizontal line
---
And this is another text.

Links

Use square brackets for the linked text followed by round clips for the url.

[Linked Text](http://url-to-a-website.com)

You can also use a shortcut for links <http://www.yourlink.de> and emails <my@emailadress.net>, but you cannot add a text for the links or emails with these shortcuts.

When rendered, Markdown will automatically obfuscate email adresses to help obscure your address from spambots.

Images

Images look similar to links, simply add an ! like this:

![image alt text](/path/to/image.jpg)

Code (inline)

To create a inline code, just use the ` sign like this:

Inline code `<?php echo 'hello world!'; ?>` within a sentence.

Code (block)

To create a code block, just indent your text with four spaces or use four ```` like this:

This text is followed by a code-block:

​````
<?php
    $string = 'hello ';
    $string .= 'world!';
    echo $string;
?>

Advanced Formats

With enhancements like Markdown Extra you can also create more complex formats like tables, abbreviations, footnotes and special attributes. TYPEMILL supports Markdown Extra, so just check the specification of Markdown Extra if you want to use these kind of formats.