WORK IN PROGRESS

Markdown Syntax Guide

This article is a cheat-sheet for me to see how markdown is rendered with my custom Hugo theme called Oakley (after my dog).

Headings

The following HTML <h1><h6> elements represent six levels of section headings. <h1> is the highest section level while <h6> is the lowest.

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5
Heading 6

Paragraph

Wlazł kotek na płotek i mruga. Piękna to piosenka, niedługa. Niedługa, nie krótka, lecz w sam raz, Zaśpiewaj, koteczku, jeszcze raz.

Strikethrough

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

If a shortcut, was a shortcut it would have been called a route. Note that you can use Markdown syntax within a blockquote.

Blockquote with attribution

“Life is really simple, but we insist on making it complicated." — Confucius1

Tables

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

NameAge
Bob the Spider2
Bob Big Spider8

Inline Markdown within tables

ItalicsBoldCode
italicsboldcode

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.

Linking notes

To link another note use See my Output post for using relative URLs. You can also link to specifiv URL See my Output post.

Images

Examples Jesmonite color combinations and marbling effect

  1. This quote is often attributed to Confucius. For more context, see Wikipedia or related philosophy references. ↩︎

Tags: