Markdown is a minimal syntax for marking up your documents with formatting, using punctuation and special characters. For those new to Markdown, this guide will help you become familiar.

The most common formatting options have keyboard shortcuts to make them easier to add:

Result Markdown Shortcut
Bold **text** Ctrl/⌘ + B
Emphasize *text* Ctrl/⌘ + I
Strike-through text Ctrl + Alt + U
Link [title](http://) Ctrl/⌘ + K
Inline Code `code` Ctrl/⌘ + Shift + K
Image ![alt](http://) Ctrl/⌘ + Shift + I
List * item Ctrl + L
Blockquote > quote Ctrl + Q
H1 # Heading1
H2 ## Heading2 Ctrl/⌘ + H
H3 ### Heading3 Ctrl/⌘ + H (x2)
H4 #### Heading4
H5 ##### Heading5
H6 ###### Heading6

Headers

Headers are set using a hash before the title. The number of hashes before the title text will determine the depth of the header. Header depths are from 1-6

  • H1 : # Header 1
  • H2 : ## Header 2
  • H3 : ### Header 3
  • H4 : #### Header 4
  • H5 : ##### Header 5
  • H6 : ###### Header 6

Text Styling

  • Links : [Title](URL)
  • Bold : **Bold**
  • Italicize : *Italics*
  • Strike-through : <del>text</del>
  • Highlight : ==text==
  • Paragraphs : Line space between paragraphs
  • Line break : Add two spaces to the end of the line
  • Lists : * an asterisk for every new list item.
  • Quotes : > Quote
  • Inline Code :
`\alert('Hello World');`
  • Horizontal Rule (HR) : ---

Images

To insert an image into your post, you need to type
![](image url here).

To title your image, all you need to do is place the title text inbetween the square brackets, e.g;

![This is a title](This is a image URL).

Writing Code

Inline code can be added using single back-ticks E.g.

`alert('Hello World')`.

For code blocks, Standard markdown works by indenting code lines with 4 spaces:

    <header>
        <h1>{{title}}</h1>
    </header>

GFM uses triple back-ticks ```

```
<header>
    <h1>{{title}}</h1>
</header>
```

Examples

Link Markdown Example

This is a paragraph that contains a link to Developer Insider.

List Markdown Example

This paragraph contains a list of items.

  • Item 1
  • Item 2
  • Item three

Quote Markdown Example

This paragraph has a quote

That is pulled out like this

from the text my post.