Markdown Syntax Guide

📅 Published 2020-08-19

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 and how these elements are translated to Gemtext by gmnhg.

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 with inline formatting

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

Footnotes

Itatur? Quiatae cullecum[^1] rem ent aut odis in re eossequodi nonsequ idebis ne sapicia[^2] is sinveli squiatum, core et que aut hariosam[^3] ex eat.

[^1]: Example footnote

[^2]: Example footnote with link to example.com

[^3]: example.com

example.com

example.com

Links

This is a simple inline link that points to the Gemini specification. It is followed by a link to the Gemtext markup specification.

Gemini specification

Gemtext markup specification

The same links are now presented as a list.

Gemini specification

Gemtext markup specification

Images

The following is an inline image:

Statue in atrium

Horizontal rule

A horizontal rule should follow this text.

---

This text is between two horizontal rules.

---

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[^4]

[^4]: The above quote is excerpted from Rob Pike's talk during Gopherfest, November 18, 2015.

talk

Blockquote with attribution and inline HTML

It is not that we have so little time but that we lose so much. ... The life we receive is not short but we make it so; we are not ill provided but use what we have wastefully.
— Seneca[^5]

[^5]: Seneca, *On the Shortness of Life*

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 |
+-------+-----+

Table with long content

+---------------+------------------------+--------------+--------------+-------------------+------------------+--------------------------------+
| Calendar Date | TD of Greatest Eclipse | Eclipse Type | Saros Series | Eclipse Magnitude | Central Duration |  Geographic Region of Eclipse  |
|               |                        |              |              |                   |                  |           Visibility           |
+---------------+------------------------+--------------+--------------+-------------------+------------------+--------------------------------+
| 2021 Jun 10   | 10:43:06               | Annular      |          147 |             0.943 | 03m51s           | n N. America, Europe, Asia     |
|               |                        |              |              |                   |                  | [Annular: n Canada, Greenland, |
|               |                        |              |              |                   |                  | Russia]                        |
| 2021 Dec 04   | 07:34:38               | Total        |          152 |             1.037 | 01m54s           | Antarctica, S. Africa, s       |
|               |                        |              |              |                   |                  | Atlantic [Total: Antarctica]   |
| 2022 Apr 30   | 20:42:36               | Partial      |          119 |             0.640 | -                | se Pacific, s S. America       |
| 2022 Oct 25   | 11:01:19               | Partial      |          124 |             0.862 | -                | Europe, ne Africa, Mid East, w |
|               |                        |              |              |                   |                  | Asia                           |
| 2023 Apr 20   | 04:17:55               | Hybrid       |          129 |             1.013 | 01m16s           | se Asia, E. Indies, Australia, |
|               |                        |              |              |                   |                  | Philippines. N.Z. [Hybrid:     |
|               |                        |              |              |                   |                  | Indonesia, Australia, Papua    |
|               |                        |              |              |                   |                  | New Guinea]                    |
+---------------+------------------------+--------------+--------------+-------------------+------------------+--------------------------------+

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

Highlight shortcodes do not currently work in gmnhg.

{{< highlight html >}} <!doctype html> Example HTML5 Document Test {{< /highlight >}}

List Types

Ordered List

1. First item

2. Second item

3. Third item

Unordered List

Nested list

* Apple

* Orange

* Banana

* Milk

* Cheese

Definition list

saudade

agape

Task list

Example task list

HTML elements — abbr, sub, sup, kbd, mark

HTML tags are fully stripped in gmnhg.

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.

Aside

This is an example of an aside.

You should see an aside block above this text.

---

Comments? Email the author: mntn at mntn.xyz

🌎 View this page on the web

☚ Back to the home page