Markdown Syntax Guide

/karzok
/reference
/markdown-syntax
659 words
4 minutes to read
date: 2019-03-11
Authors:
Konrad Geletey
Hugo Authors

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 Pike¹

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

Inline	Markdown	In	Table
italics	bold	~~strikethrough~~	`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>

List Types

Ordered List

First item
Second item
Third item

Unordered List

List item
Another item
And another item

Nested list

Item
1. First Sub-item
2. Second Sub-item

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.

Katex

$$ f(x) = \int_{-\infty}^\infty\hat f(\xi),e^{2 \pi i \xi x},d\xi $$

$$ x_1 \ x_2 \ x_3 % $$

katex shortocde

{% katex(block=true) %}
{%end %}

$1\% \\ x$

Media

Images

Image in local directory Image no loaded testing Media CDN

Hints

default

{% hint(style="") %} 
{% end %}

Regular note highlighted in blue

warning

{% hint(style="warning") %} 
{% end %}

Caution! Doors are closed! This type is for such notes

critical

{% hint(style="critical") %} 
{% end %}

This note is about danger to life or the use of this thing in the project For example, it can cause non-standart behavior

Mermaid

It's a fairly large library ~ 1 MB js files, therefore it will slow down the site, we recommend using the diagram tools on the local machine, and upload images

{% mermaid() %}
{% end %}

flowchart TD
  Start --> Stop

The above quote is excerpted from Rob Pike's talk during Gopherfest, November 18, 2015.