Markdown
Hugo supports Markdown syntax for formatting text, creating lists, and more. This page will show you some of the most common Markdown syntax examples.
Markdown Examples
Styling Text
Style | Syntax | Example | Output |
---|---|---|---|
Bold | **bold text** |
**bold text** |
bold text |
Italic | *italicized text* |
*italicized text* |
italicized text |
Strikethrough | ~~strikethrough text~~ |
~~strikethrough text~~ |
|
Subscript | <sub></sub> |
This is a <sub>subscript</sub> text |
This is a subscript text |
Superscript | <sup></sup> |
This is a <sup>superscript</sup> text |
This is a superscript text |
Blockquotes
Blockquote with attribution
Don’t communicate by sharing memory, share memory by communicating. — Rob Pike1
Markdown
> Don't communicate by sharing memory, share memory by communicating.<br>
> — <cite>Rob Pike[^1]</cite>
[^1]: The above quote is excerpted from Rob Pike's [talk](https://www.youtube.com/watch?v=PAAkCSZUG1c) during Gopherfest, November 18, 2015.
Tables
Tables aren’t part of the core Markdown spec, but Hugo supports them out-of-the-box.
Name | Age |
---|---|
Bob | 27 |
Alice | 23 |
Markdown
| Name | Age |
|--------|------|
| Bob | 27 |
| Alice | 23 |
Inline Markdown within tables
Italics | Bold | Code |
---|---|---|
italics | bold | code |
Markdown
| Italics | Bold | Code |
| -------- | -------- | ------ |
| *italics* | **bold** | `code` |
Code Blocks
Lists
Ordered List
- First item
- Second item
- Third item
Markdown
1. First item
2. Second item
3. Third item
Unordered List
- List item
- Another item
- And another item
Markdown
* List item
* Another item
* And another item
Nested list
- Fruit
- Apple
- Orange
- Banana
- Dairy
- Milk
- Cheese
Markdown
* Fruit
* Apple
* Orange
* Banana
* Dairy
* Milk
* Cheese
Images
Markdown
![landscape](https://picsum.photos/800/600)
With caption:
Markdown
![landscape](https://picsum.photos/800/600 "Unsplash Landscape")
Configuration
Hugo uses Goldmark for Markdown parsing.
Markdown rendering can be configured in hugo.yaml
under markup.goldmark
.
Below is the default configuration for Hextra:
hugo.yaml
markup:
goldmark:
renderer:
unsafe: true
highlight:
noClasses: false
For more configuration options, see Hugo documentation on Configure Markup.