This is a comprehensive reference containing all the example content from the Hugo blog awesome theme. Use this as a reference for various Hugo features and markdown syntax.

Table of Contents Configuration

This theme supports displaying table of content (ToC) in blog posts.

Parameters

You can manage a ToC with two parameters:

• global toc parameter;
• post toc parameter.

The post toc parameter has higher priority than the global toc parameter.

Enable table of content on all posts

To enable ToC on all posts (globally) set parameter toc to true in hugo.toml.

[params]
  toc = true

To disable ToC globally, simply ignore the toc parameter or set it to false.

Enable table of content on certain posts

To enable ToC on certain posts set parameter toc to true in post settings.

---
title: How to enable table of content
date: 2023-05-02
toc: true
---

Disable table of content on certain posts

To disable ToC on certain posts, you have to follow two steps.

Notice: .Params.toc in the post will override .Site.Params.toc. After these steps, parameter toc in the post will be false.

1. Set parameter toc to true in hugo.toml.

   [params]
     toc = true
   

2. Add toc = false to the front matter of the post for which you wish to disable ToC.

   ---
   title: How to enable table of content
   date: 2023-05-02
   toc: false
   ---
   

Open table of content

By default, ToC is closed. To open it by default, set parameter tocOpen to true in hugo.toml.

[params]
  tocOpen = true

Or simply add the tocOpen parameter to the front matter of the post.

---
title: How to enable table of content
date: 2023-05-02
tocOpen: true
---

Math Typesetting

Mathematical notation in a Hugo project can be enabled by using third party JavaScript libraries.

In this example we will be using KaTeX.

• To enable KaTeX globally, set the parameter math to true in a project’s configuration file as follows.

  • hugo.toml

    [params]
      math = true
    

  • hugo.yaml

    params:
      math: true
    

• To enable KaTeX on a per page basis, include the parameter math: true in Front Matter of Markdown content file as follows.

  ---
  math: true
  ---
  

Note: The online reference of Supported TeX Functions is a helpful resource.

Math Examples

• Block math:

  $$ \varphi = 1+\frac{1} {1+\frac{1} {1+\frac{1} {1+\cdots} } } $$

• Inline math:

  This is an inline polynomial: $5x^2 + 2y -7$.

Rich Content & Shortcodes

Hugo ships with several Built-in Shortcodes for rich content, along with a Privacy Config and a set of Simple Shortcodes that enable static and no-JS versions of various social media embeds.

YouTube Privacy Enhanced Shortcode

Twitter Simple Shortcode

“In addition to being more logical, asymmetry has the advantage that its complete appearance is far more optically effective than symmetry.”
— Jan Tschichold pic.twitter.com/gcv7SrhvJb
— Design Reviewed | Graphic Design History (@DesignReviewed) January 17, 2019

Vimeo Simple Shortcode

Emoji Support

Emoji can be enabled in a Hugo project in a number of ways.

The emojify function can be called directly in templates or Inline Shortcodes.

To enable emoji globally, set enableEmoji to true in your site’s hugo.toml. You can type emoji shorthand codes directly in content files; e.g.

:see_no_evil: 🙈 :hear_no_evil: 🙉 :speak_no_evil: 🙊

I ❤️ Hugo! 😁

The Emoji cheat sheet is a useful reference for emoji shorthand codes.

N.B. The above steps enable Unicode Standard emoji characters and sequences in Hugo, however the rendering of these glyphs depends on the browser and the platform. To style the emoji you can either use a third party emoji font or a font stack; e.g.

.emoji {
  font-family: Apple Color Emoji, Segoe UI Emoji, NotoColorEmoji, Segoe UI Symbol, Android Emoji, EmojiSymbols;
}

Markdown Syntax Guide

This section 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.

Image

You can use the following syntax to include an image. Path of the image should be relative to the index.md file.

![Landscape](1.jpg)

You can also include image from external sources.

![Image](https://source.unsplash.com/random/600x400/?tech)

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

You can use Markdown syntax within a blockquote, like bold, italics, links, code.

Blockquote with attribution

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

Tables

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

Markdown within tables

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>

Inline code

Use the backtick to refer to a variable within a sentence.

List Types

Ordered List

1. First item
2. Second item with some code in it
3. Third item

Unordered List

• List item
• Another item with some code in it
• 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.

H₂O

Xⁿ + Yⁿ = Zⁿ

Press CTRL+ALT+Delete to end the session.

Most salamanders are nocturnal, and hunt for insects, worms, and other small creatures.

Placeholder Text Examples

Lorem est tota propiore conpellat pectoribus de pectora summo. Redit teque digerit hominumque toris verebor lumina non cervice subde tollit usus habet Arctonque, furores quas nec ferunt. Quoque montibus nunc caluere tempus inhospita parcite confusaque translucet patri vestro qui optatis lumine cognoscere flos nubis! Fronde ipsamque patulos Dryopen deorum.

1. Exierant elisi ambit vivere dedere
2. Duce pollice
3. Eris modo
4. Spargitque ferrea quos palude

Rursus nulli murmur; hastile inridet ut ab gravi sententia! Nomine potitus silentia flumen, sustinet placuit petis in dilapsa erat sunt. Atria tractus malis.

1. Comas hunc haec pietate fetum procerum dixit
2. Post torum vates letum Tiresia
3. Flumen querellas
4. Arcanaque montibus omnes
5. Quidem et

Vagus elidunt

The Van de Graaf Canon

Mane refeci capiebant unda mulcebat

Victa caducifer, malo vulnere contra dicere aurato, ludit regale, voca! Retorsit colit est profanae esse virescere furit nec; iaculi matertera et visa est, viribus. Divesque creatis, tecta novat collumque vulnus est, parvas. Faces illo pepulere tempus adest. Tendit flamma, ab opes virum sustinet, sidus sequendo urbis.

Iubar proles corpore raptos vero auctor imperium; sed et huic: manus caeli Lelegas tu lux. Verbis obstitit intus oblectamina fixis linguisque ausus sperare Echionides cornuaque tenent clausit possit. Omnia putatur. Praeteritae refert ausus; ferebant e primus lora nutat, vici quae mea ipse. Et iter nil spectatae vulnus haerentia iuste et exercebat, sui et.

Eurytus Hector, materna ipsumque ut Politen, nec, nate, ignari, vernum cohaesit sequitur. Vel mitis temploque vocatus, inque alis, oculos nomen non silvis corpore coniunx ne displicet illa. Crescunt non unus, vidit visa quantum inmiti flumina mortis facto sic: undique a alios vincula sunt iactata abdita! Suspenderat ego fuit tendit: luna, ante urbem Propoetides parte.