Markdown Syntax Guide

Posted: Nov 17, 2020 ·  Updated: Dec 17, 2020 · 3 min.
Web Development

Sample article showcasing basic Markdown syntax and formatting for HTML elements.

Markdown HTML

Part of the Learn Markdown series:

  1. Markdown Syntax GuideThis post!
  2. Markdown Syntax Guide 2

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 Link to this heading

The following HTML <h2>—<h6> elements represent five levels of section headings. <h2> is the highest section level you should use in markdown while <h6> is the lowest. <h1> should be reserved for the page title.

H2 Link to this heading

H3 Link to this heading

H4 Link to this heading

H5 Link to this heading
H6 Link to this heading

Paragraph Link to this heading

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 Link to this heading

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 Link to this heading

Tiam, ad mint andaepu dandae nostion secatur sequo quae. Note that you can use Markdown syntax within a blockquote.

Blockquote with attribution Link to this heading

Don’t communicate by sharing memory, share memory by communicating.
— Rob Pike1

Tables Link to this heading

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 Link to this heading

Italics Bold Code
italics bold code

Code Blocks Link to this heading

Code block with backticks Link to this heading

html
 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 indented with four spaces Link to this heading 

<!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 Link to this heading 

 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>

List Types Link to this heading

Ordered List Link to this heading

  1. First item
  2. Second item
  3. Third item

Unordered List Link to this heading

  • List item
  • Another item
  • And another item

Nested list Link to this heading

  • Fruit
    • Apple
    • Orange
    • Banana
  • Dairy
    • Milk
    • Cheese

Other Elements — abbr, sub, sup, kbd, mark Link to this heading

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.

  1. The above quote is excerpted from Rob Pike’s talk during Gopherfest, November 18, 2015. ↩︎