Markdown Syntax Guide

Mar 11, 2019 00:00 ยท 444 words ยท 3 minute read

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.

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 ๐Ÿ”—

Italics Bold Code
italics bold code

Code Blocks ๐Ÿ”—

Code block with backticks ๐Ÿ”—

<!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 ๐Ÿ”—

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>Example HTML5 Document</title>
</head>
<body>
  <p>Test</p>
</body>
</html>

List Types ๐Ÿ”—

Ordered List ๐Ÿ”—

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

Unordered List ๐Ÿ”—

  • List item
  • Another item
  • And another item

Nested list ๐Ÿ”—

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

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.


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

comments powered by Disqus