Formatting

May 10, 2024 • 18:20 / 1 min read
#markdown #formatting #typography #documentation #reference
Table of contents

Headings

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5
Heading 6

Emphasis

Regular text, bold text, italic text, bold and italic, strikethrough, and inline code.

Table

LanguageParadigmTyping
GoCompiledStatic
PythonInterpretedDynamic
RustCompiledStatic
JavaScriptInterpretedDynamic

Blockquotes

///
i — This is a standard note blockquote.
///
↑ — This is a tip.
///
! — This is a warning.
///
i — This is an important blockquote.

Horizontal Rule

Above the rule.

Below the rule.

Lists

Unordered:

  • Item one
  • Item two
    • Nested item
    • Another nested item
  • Item three

Ordered:

  1. First step
  2. Second step
    1. Sub-step A
    2. Sub-step B
  3. Third step

Task list:

  • Set up Hugo
  • Configure theme
  • Write content
  • Deploy to production