midtowndrafting.com/content/docs/guide/markdown.md
2024-05-03 19:04:48 -04:00

2.7 KiB

title weight
Markdown 2

Hugo supports Markdown syntax for formatting text, creating lists, and more. This page will show you some of the most common Markdown syntax examples.

Markdown Examples

Styling Text

Style Syntax Example Output
Bold **bold text** **bold text** bold text
Italic *italicized text* `italicized text italicized text
Strikethrough ~~strikethrough text~~ ~~strikethrough text~~ strikethrough text
Subscript <sub></sub> This is a <sub>subscript</sub> text This is a subscript text
Superscript <sup></sup> This is a <sup>superscript</sup> text This is a superscript text

Blockquotes

Blockquote with attribution

Don't communicate by sharing memory, share memory by communicating.
Rob Pike1

Tables

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

Name Age
Bob 27
Alice 23

Inline Markdown within tables

Italics Bold Code
italics bold code

Code Blocks

{{< cards >}} {{< card link="../../guide/syntax-highlighting" title="Syntax Highlighting" icon="sparkles" >}} {{< /cards >}}

Lists

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

Images

With caption:

Configuration

Hugo uses Goldmark for Markdown parsing. Markdown rendering can be configured in hugo.yaml under markup.goldmark. Below is the default configuration for Hextra:

markup:
  goldmark:
    renderer:
      unsafe: true
  highlight:
    noClasses: false

For more configuration options, see Hugo documentation on Configure Markup.

Learning Resources


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