2020-10-27 09:21:58 -04:00
---
author: "Hugo Authors"
title: "Markdown Syntax Guide"
date: "2019-03-11"
description: "Sample article showcasing basic Markdown syntax and formatting for HTML elements."
tags: ["markdown", "css", "html", "themes"]
categories: ["themes", "syntax"]
series: ["Themes Guide"]
aliases: ["migrate-from-jekyl"]
ShowToc: true
TocOpen: true
---
2019-03-11 12:58:40 -04:00
2019-03-11 18:53:47 -04:00
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.
2020-10-27 09:16:08 -04:00
2019-03-11 12:58:40 -04:00
<!-- more -->
## 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
2020-10-27 09:16:08 -04:00
2019-03-11 12:58:40 -04:00
## H2
2020-10-27 09:16:08 -04:00
2019-03-11 12:58:40 -04:00
### H3
2020-10-27 09:16:08 -04:00
2019-03-11 12:58:40 -04:00
#### H4
2020-10-27 09:16:08 -04:00
2019-03-11 12:58:40 -04:00
##### H5
2020-10-27 09:16:08 -04:00
2019-03-11 12:58:40 -04:00
###### 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.
2019-03-11 18:53:47 -04:00
#### Blockquote without attribution
2019-03-11 12:58:40 -04:00
> Tiam, ad mint andaepu dandae nostion secatur sequo quae.
2020-10-27 09:16:08 -04:00
> **Note** that you can use _Markdown syntax_ within a blockquote.
2019-03-11 12:58:40 -04:00
2019-03-11 18:53:47 -04:00
#### Blockquote with attribution
2019-03-11 12:58:40 -04:00
2021-01-13 10:02:37 -05:00
> Don't communicate by sharing memory, share memory by communicating.
>
2019-03-11 18:53:47 -04:00
> — <cite>Rob Pike[^1]</cite>
2019-03-11 12:58:40 -04:00
2019-03-11 18:53:47 -04:00
[^1]: The above quote is excerpted from Rob Pike's [talk ](https://www.youtube.com/watch?v=PAAkCSZUG1c ) during Gopherfest, November 18, 2015.
2019-03-11 12:58:40 -04:00
## Tables
2021-12-24 09:59:58 -05:00
Tables aren't part of the core Markdown spec, but Hugo supports them out-of-the-box.
2019-03-11 12:58:40 -04:00
2020-10-27 09:16:08 -04:00
| Name | Age |
| ----- | --- |
| Bob | 27 |
| Alice | 23 |
2019-03-11 12:58:40 -04:00
2019-03-11 18:53:47 -04:00
#### Inline Markdown within tables
2019-03-11 12:58:40 -04:00
2020-06-03 14:34:16 -04:00
| Italics | Bold | Code |
2020-10-27 09:16:08 -04:00
| --------- | -------- | ------ |
| _italics_ | **bold** | `code` |
2019-03-11 12:58:40 -04:00
## Code Blocks
2019-03-11 18:53:47 -04:00
#### Code block with backticks
2019-03-11 12:58:40 -04:00
2020-06-03 14:34:16 -04:00
```html
2020-10-27 09:16:08 -04:00
<!DOCTYPE html>
2019-03-11 12:58:40 -04:00
< html lang = "en" >
2020-10-27 09:16:08 -04:00
< head >
< meta charset = "utf-8" / >
< title > Example HTML5 Document< / title >
< / head >
< body >
< p > Test< / p >
< / body >
2019-03-11 12:58:40 -04:00
< / html >
```
2020-06-03 14:34:16 -04:00
2019-03-11 18:53:47 -04:00
#### Code block indented with four spaces
2019-03-11 12:58:40 -04:00
2020-06-03 14:34:16 -04:00
<!doctype html>
2019-03-11 12:58:40 -04:00
< html lang = "en" >
< head >
2020-06-03 14:34:16 -04:00
< meta charset = "utf-8" >
2019-03-11 12:58:40 -04:00
< title > Example HTML5 Document< / title >
< / head >
< body >
< p > Test< / p >
< / body >
< / html >
2019-03-11 18:53:47 -04:00
#### Code block with Hugo's internal highlight shortcode
2020-10-27 09:16:08 -04:00
2019-03-11 12:58:40 -04:00
{{< highlight html > }}
2020-10-27 09:16:08 -04:00
2020-06-03 14:34:16 -04:00
<!doctype html>
2019-03-11 12:58:40 -04:00
< html lang = "en" >
< head >
2020-06-03 14:34:16 -04:00
< meta charset = "utf-8" >
2019-03-11 12:58:40 -04:00
< title > Example HTML5 Document< / title >
< / head >
< body >
< p > Test< / p >
< / body >
< / html >
{{< / highlight > }}
2021-01-22 00:17:09 -05:00
#### Gist
{{< gist spf13 7896402 > }}
2019-03-11 12:58:40 -04:00
## List Types
2019-03-11 18:53:47 -04:00
#### Ordered List
2019-03-11 12:58:40 -04:00
1. First item
2. Second item
3. Third item
2019-03-11 18:53:47 -04:00
#### Unordered List
2019-03-11 12:58:40 -04:00
2020-10-27 09:16:08 -04:00
- List item
- Another item
- And another item
2019-03-11 12:58:40 -04:00
2019-03-11 18:53:47 -04:00
#### Nested list
2019-03-11 12:58:40 -04:00
2020-10-27 09:16:08 -04:00
- Fruit
- Apple
- Orange
- Banana
- Dairy
- Milk
- Cheese
2019-03-11 12:58:40 -04:00
## Other Elements — abbr, sub, sup, kbd, mark
< abbr title = "Graphics Interchange Format" > GIF< / abbr > is a bitmap image format.
H< sub > 2< / sub > O
X< sup > n< / sup > + Y< sup > n< / sup > = Z< sup > n< / sup >
Press < kbd > < kbd > CTRL< / kbd > +< kbd > ALT< / kbd > +< kbd > Delete< / kbd > < / kbd > to end the session.
2019-03-11 18:53:47 -04:00
Most < mark > salamanders< / mark > are nocturnal, and hunt for insects, worms, and other small creatures.