Markdown Syntax Guide

Sample article showcasing basic Markdown syntax and formatting for HTML elements

MarkdownSyntaxExample 4 min FreeCAD
a cover alternative title

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.

HeadingsLink to this heading

The following HTML <h1>—<h6> elements represent six levels of section headings. <h1> is the highest section level while <h6> is the lowest.

H1Link to this heading

H2Link to this heading

H3Link to this heading

H4Link to this heading

H5Link to this heading
H6Link to this heading

ParagraphLink 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.

BlockquotesLink 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 attributionLink to this heading

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

Blockquote with attributionLink to this heading

Don’t communicate by sharing memory, share memory by communicating.

— Rob Pike1

TablesLink to this heading

Tables aren’t part of the core Markdown spec, but Hugo supports them out-of-the-box.

NameAge
Bob27
Alice23

Inline Markdown within tablesLink to this heading

ItalicsBoldCode
italicsboldcode

Code BlocksLink to this heading

Inline CodeLink to this heading

This is Inline Code

Only preLink to this heading

This is pre text

Code block with backticksLink 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 backticks and language specifiedLink to this heading

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="utf-8" />
        <title>Example HTML5 Document</title>
        <meta name="description" content="Sample article showcasing basic Markdown syntax and formatting for HTML elements.">
    </head>
    <body>
        <p>Test</p>
    </body>
</html>

Code block indented with four spacesLink 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 shortcodeLink 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>

GistLink to this heading

List TypesLink to this heading

Ordered ListLink to this heading

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

Unordered ListLink to this heading

  • List item
  • Another item
  • And another item

Nested listLink to this heading

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

Other Elements — abbr, sub, sup, kbd, markLink to this heading

GIF is a bitmap image format.

H2O

Xn + Yn = Zn

Press CTRL+ALT+Delete to end the session.

Most reptiles and salamanders are nocturnal and hunt for insects, worms and other small creatures. Note that most reptiles are nocturnal and hunt for insects, worms and other small creatures. Most reptiles and salamanders are nocturnal and hunt for insects, worms and other small creatures. Note that most reptiles 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. ↩︎