note

This article was last updated on February 23, 2023, 1 year ago. The content may be out of date.

Overview

Contents below are directly modified from the official cheatsheet with syntax not supported by Hugo removed.

Basic Syntax

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

Heading

# H1
## H2
### H3

Bold

**bold text**

Italic

*italicized text*

Blockquote

> blockquote

Ordered List

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

Unordered List

- First item
- Second item
- Third item

Code

`code`

Horizontal Rule

---

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

Image

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

Fenced Code Block 1

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

Footnote

Here's a sentence with a footnote. [^1]

[^1]: This is the footnote.

Heading ID

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

Definition List

term
: definition

Strikethrough

~~The world is flat.~~

Task List

- [x] Write the press release
- [ ] Update the website
- [ ] Contact the media

Emoji

That is so funny! :joy:

(See also Copying and Pasting Emoji)

  1. To escape Fenced Code block, just surround that block which a pair of ~~~. ↩︎