3.9 KiB
+++ author = "Hugo Authors" title = "Markdown Syntax Guide" date = "2024-05-07" description = "Sample article showcasing basic Markdown syntax and formatting for HTML elements." tags = [ "markdown", "css", "html", "themes", ] categories = [ "themes", "syntax", ] authors = ["Junyi-99", "hugo"] aliases = ["migrate-from-jekyl"] favorite = true +++
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 <h2>—<h6> elements represent 5 levels of section headings. <h2> is the highest section level while <h6> is the lowest.
H2
You should using ## H2 as your section title, since the file title is # H1
If you use # H1 as your section title, you will get a warning from linter:
MD025/single-title/single-h1: Multiple top-level headings in the same document
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? 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.
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.
Blockquote without attribution
Tiam, ad mint andaepu dandae nostion secatur sequo quae.
Note that you can use Markdown syntax within a blockquote.
Blockquote with attribution
Don't communicate by sharing memory, share memory by communicating.
— Rob Pike1
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
| Inline | Markdown | In | Table |
|---|---|---|---|
| italics | bold | code |
Code Blocks
Code block with backticks and showing highlighted lines
199
200
201
202
203
204
205
206
207
208
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Example HTML5 Document</title>
</head>
<body>
<p>Test</p>
</body>
</html>
Code block indented with four spaces
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Example HTML5 Document</title>
</head>
<body>
<p>Test</p>
</body>
</html>
Code block with Hugo's internal highlight shortcode
{{< highlight html >}}
<html lang="en"> <head> </head>Test
</html> {{< /highlight >}}List Types
Ordered List
- First item
- Second item
- Third item
Unordered List
- List item
- Another item
- And another item
Nested list
- Item
-
First Sub-item
-
Second Sub-item
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.