Markdown Cheat Sheet
Hugo has excellent Markdown support out of the box. By default, Hugo uses the Goldmark Markdown processor which is fully CommonMark-compliant. See the configuration instructions to learn more about the extensions you can configure.
Overview
You can refer to the table below for an overview of basic markdown syntax:
TASK | MARKDOWN SYNTAX |
---|---|
Heading 1 | # |
Heading 2 | ## |
Heading 3 | ### |
Italics | *italics* |
Bold | **Bold** |
Strike | ~~strike~~ |
Blockquote | > |
Links | [link name](https://link.com) |
Images | ![Image name](image.png) |
Unordered list | * List item |
Ordered list | 1. List item |
Inline Code | `insert code here` |
{.table .table-sm .table-striped .table-hover} |
Headings
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
Heading 1
Heading 2
Heading 3
Heading 4
Heading 5
Heading 6
Lists
* Unordered item
* Unordered item
* Unordered item
1. Ordered item
2. Ordered item
3. Ordered item
- [ ] Task item
- [x] Checked Task item
- [ ] Task item
- Unordered item
- Unordered item
- Unordered item
- Ordered item
- Ordered item
- Ordered item
- Task item
- Checked Task item
- Task item
Format
**Bold**
*Italic*
<u>Underline</u>
<sup>Superscript</sup>
<sub>Subscript</sub>
<mark>Highlight</mark>
`Inline code`
~~Strikethrough~~
[Hyperlink](http://example.com)
![Image](placeholder-50-09f-fff.png)
{ .img-fluid }
Bold
Italic
Underline
Superscript
Subscript
Highlight
Inline code
Strikethrough
{ .img-fluid }
Table
| Header 1 | Header 2 |
| -------- | -------- |
| Cell 1 | Cell 2 |
| Cell 3 | Cell 4 |
Header 1 | Header 2 |
---|---|
Cell 1 | Cell 2 |
Cell 3 | Cell 4 |
Blockquote
> Blockquote
> Second line
>
> -- Author
Blockquote
Second line– Author
Code Block
```go
package main
import "fmt"
func main() {
fmt.Println("hello world")
}
```
package main
import "fmt"
func main() {
fmt.Println("hello world")
}
HTML
<div>
<p>Hello world</p>
</div>