Home Markdown Cheat Sheet
Post
Cancel

Markdown Cheat Sheet

Markdown Cheat Sheet

This Markdown cheat sheet provides a quick overview of all the Markdown syntax elements. It can’t cover every edge case, so if you need more information about any of these elements, refer to the reference guides for basic syntax and extended syntax.


Basic Syntax

These are the elements outlined in John Gruber’s original design document. All Markdown applications support these elements.

Headings

Heading 1

# Heading 1

Heading 2

## Heading 2

Heading 3

### Heading 3

Heading 4

#### Heading 4

Heading 5

##### Heading 5

Heading 6

###### Heading 6


Bold

some bold text **some bold text**


Italics

other italicized text *other italicized text*


Blockquotes

this is a blockquote > this is a blockquote


Ordered Lists

  1. First ordered item
  2. Second ordered item
  3. Third ordered item
1
2
3
1. First ordered item
2. Second ordered item
3. Third ordered item

Unordered Lists

  • First unordered item
  • Second unordered item
  • Third unordered item
1
2
3
- First unordered item
- Second unordered item
- Third unordered item

Code

Example 1 (Single Line):

code

1
`code`

Example 2 (Fenced Code Block):

1
2
3
multiple
lines of
code

Use three ticks (no spaces) on the lines before and after multiple lines of code

1
2
3
4
5
```
multiple
lines of
code
```

Example 3 (Syntax Highlighting):

1
2
// the hello world program
console.log('Hello World');

You can add the name of the language at the end of the first set of three ticks (no spaces) for syntax highlighting

1
2
3
4
``` javascript
// the hello world program
console.log('Hello World');
```

*Note that not all markdown applications support examples 2 and 3


Horizontal Rule


Use three dashes or three underscores on their own line

1
2
---
___

Markdown Guide Website [Markdown Guide Website](https://www.markdownguide.org)


Image

alt text ![alt text](https://www.markdownguide.org/assets/images/tux.png)


Extended Syntax

These elements extend the basic syntax by adding additional features. Not all Markdown applications support these elements.

Table

| Syntax | Description | | ———– | ———– | | Header | Title | | Paragraph | Text |

1
2
3
4
| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |

Footnote

Here’s a sentence with a footnote. [^1] [^1]: This is the footnote.

1
2
Here's a sentence with a footnote. [^1]
[^1]: This is the footnote.

Heading ID

My Great Heading

##### My Great Heading {#custom-id}


Definition List

term
definition ``` term
definition ```

Strikethrough

The world is flat. ~~The world is flat.~~


Task List

  • Write the press release
  • Update the website
  • Contact the media ```
  • Write the press release
  • Update the website
  • Contact the media ```

Emoji

That is so funny! :joy: That is so funny! :joy:

(See also Copying and Pasting Emoji)


Highlight

I need to highlight these ==very important words==. I need to highlight these ==very important words==.


Subscript

H~2~O H~2~O


Superscript

X^2^ X^2^


This guide was adapted from the Markdown Cheat Sheet found at the Markdown Guide website.
This post is licensed under CC BY 4.0 by the author.