Skip to content

Markdown Cheat Sheet

Provided by The Markdown Guide!

Basic Syntax

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

Headings

markdown
# H1
## H2
### H3
#### H4
##### H5
###### H6

Bold

bold text

markdown
**bold text**

Italic

italicized text

markdown
*italicized text*

Blockquote

blockquote

markdown
> blockquote

Ordered List

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

Unordered List

  • First item
  • Second item
  • Third item
markdown
- First item
- Second item
- Third item

Code

code

markdown
`code`

Horizontal Rule


markdown
---

Markdown Guide

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

Image

alt text

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

TablesAreCool
col 3 isright-aligned$1600
col 2 iscentered$12
zebra stripesare neat$1
markdown
| Tables        |      Are      |  Cool |
| ------------- | :-----------: | ----: |
| col 3 is      | right-aligned | $1600 |
| col 2 is      |   centered    |   $12 |
| zebra stripes |   are neat    |    $1 |

Fenced Code Block

{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}
```
{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}
```

Heading ID

My Great Heading

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

Strikethrough

The world is flat.

markdown
~~The world is flat.~~

Emoji

That is so funny! 😂

markdown
That is so funny! :joy:

(See also Copying and Pasting Emoji)

VitePress Specific

Provided by VitePress Markdown Extensions

NOTE

Highlights information that users should take into account, even when skimming.

TIP

Optional information to help a user be more successful.

IMPORTANT

Crucial information necessary for users to succeed.

WARNING

Critical content demanding immediate user attention due to potential risks.

CAUTION

Negative potential consequences of an action.

> [!NOTE]
> Highlights information that users should take into account, even when skimming.

> [!TIP]
> Optional information to help a user be more successful.

> [!IMPORTANT]
> Crucial information necessary for users to succeed.

> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.

> [!CAUTION]
> Negative potential consequences of an action.

Table of Contents

[[toc]]