This article offers a sample of basic Markdown syntax that can be used in Hugo content files. Also, it shows whether key HTML elements are decorated with CSS in a Hugo theme.

Note: this was written by the Hugo maintainers, not myself. I included it here to illustrate features of the theme. Some grammatical changes were made as needed.

Headings Link to this heading

The following HTML <h2>—<h6> elements represent five levels of section headings. <h2> is the highest section level recommended for 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

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus porttitor non nisi eu molestie. In mi orci, imperdiet a massa et, imperdiet tincidunt turpis. Proin in varius diam. Aliquam erat volutpat. Vestibulum in aliquet odio. Aenean sodales sapien id nisi finibus, scelerisque luctus mauris dictum. Vestibulum ornare sem mi, ut malesuada ipsum faucibus vel.

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 quoted from another source, with an optional citation within a <footer> or <cite> and optional inline 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 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 (no highlighting) 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 at Gopherfest on November 18, 2015. ↩︎

#Hugo #Markdown

Read Next