Markdown Syntax Guide
Sample article showcasing basic Markdown syntax and formatting for HTML elements.
Become a backer or sponsor to support our work.
This article offers a sample of basic Markdown syntax that can be used in Hugo content files, also it shows whether basic HTML elements are decorated with CSS in a Hugo theme.
Headings
The following HTML <h1>—<h6> elements represent six levels of section headings. <h1> is the highest section level while <h6> is the lowest.
H1
H2
H3
H4
H5
H6
Paragraph
Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata tiustia prat.
Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat.
Blockquotes
The blockquote element represents content that is quoted from another source, optionally with a citation which must be within a footer or cite element, and optionally with in-line changes such as annotations and abbreviations.
Blockquotes Parameters
hugo.toml
1[params]
2 [params.hb]
3 [params.hb.blockquotes]
4 border_style = 'primary'
5 border_width = 4
6 bordered = true
hugo.yaml
1params:
2 hb:
3 blockquotes:
4 border_style: primary
5 border_width: 4
6 bordered: true
hugo.json
1{
2 "params": {
3 "hb": {
4 "blockquotes": {
5 "border_style": "primary",
6 "border_width": 4,
7 "bordered": true
8 }
9 }
10 }
11}
Blockquote without attribution
1> Tiam, ad mint andaepu dandae nostion secatur sequo quae.
2>
3> **Note** that you can use *Markdown syntax* within a blockquote.Tiam, ad mint andaepu dandae nostion secatur sequo quae.
Note that you can use Markdown syntax within a blockquote.
Blockquote with attribution
1> Don't communicate by sharing memory, share memory by communicating.
2{caption="The above quote is excerpted from Rob Pike's [talk](https://www.youtube.com/watch?v=PAAkCSZUG1c) during Gopherfest, November 18, 2015."}Don’t communicate by sharing memory, share memory by communicating.
Blockquote alignments
1> Align to the center
2{align=center}Align to the center
1> Align to the end
2{align=end}Align to the end
Tables
Tables aren’t part of the core Markdown spec, but Hugo supports supports them out-of-the-box.
| Name | Age |
|---|---|
| Bob | 27 |
| Alice | 23 |
Inline Markdown within tables
| Italics | Bold | Code |
|---|---|---|
| italics | bold | code |
Advanced Table Usage
See Tables for details.
Code Blocks
Code block with backticks
1<!doctype html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <title>Example HTML5 Document</title>
6</head>
7<body>
8 <p>Test</p>
9</body>
10</html>
Code block with Hugo’s internal highlight shortcode
1<!doctype html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <title>Another Example HTML5 Document</title>
6</head>
7<body>
8 <p>A looooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong text</p>
9</body>
10</html>List Types
Ordered List
- First item
- Second item
- Third item
Unordered List
- List item
- Another item
- And another item
Nested List
- Fruit
- Apple
- Orange
- Banana
- Dairy
- Milk
- Cheese
TODO List
- Done
- WIP
- TODO
Images
1
Read more on images usage, start processing images in Markdown way.
Other Elements — abbr, sub, sup, kbd, mark
GIF is a bitmap image format.
H2O
Xn + Yn = Zn
Press CTRL+ALT+Delete to end the session.
Most salamanders are nocturnal, and hunt for insects, worms, and other small creatures.
