Unified Markdown Cheat Sheet

This page provides a comprehensive, single‑page Markdown reference showing syntax and compatibility across VS Code, GitHub, and Hugo.

Hugo compatibility assumes the following Goldmark settings:

[markup]
  [markup.goldmark]
    [markup.goldmark.renderer]
      unsafe = true
    [markup.goldmark.extensions]
      table = true
      strikethrough = true
      taskList = true
      linkify = true
      footnote = true
      typographer = false

1. Headings

Syntax

# H1
## H2
### H3

Compatibility

FeatureVS CodeGitHubHugo
Headings✔️✔️✔️

2. Bold, Italic, Bold+Italic

Syntax

*italic* or _italic_
**bold** or __bold__
***bold italic*** or ___bold italic___

Compatibility

FeatureVS CodeGitHubHugo
Bold/Italic✔️✔️✔️

Syntax

[link text](https://example.com)

Compatibility

FeatureVS CodeGitHubHugo
Links✔️✔️✔️

4. Images

Syntax

![alt text](image.png)

Compatibility

FeatureVS CodeGitHubHugo
Images✔️✔️✔️

5. Code (Inline & Block)

Syntax

Inline: Use code like this.

Block: console.log("hello");

Compatibility

FeatureVS CodeGitHubHugo
Inline code✔️✔️✔️
Fenced code blocks✔️✔️✔️
Syntax highlighting✔️✔️✔️ (via Chroma)

6. Blockquotes

Syntax

> This is a quote.

Compatibility

FeatureVS CodeGitHubHugo
Blockquotes✔️✔️✔️

7. Lists (Ordered & Unordered)

Syntax

- Item
- Item

1. First
2. Second

Compatibility

FeatureVS CodeGitHubHugo
Lists✔️✔️✔️

8. Task Lists (GFM)

Syntax

- [ ] Task
- [x] Done

Compatibility

FeatureVS CodeGitHubHugo
Task lists✔️✔️✔️*

Hugo: requires taskList = true.


9. Tables (GFM)

Syntax

| A | B |
|---|---|
| 1 | 2 |

Compatibility

FeatureVS CodeGitHubHugo
Tables✔️✔️✔️*

Hugo: requires table = true.


10. Strikethrough

Syntax

~~text~~

Compatibility

FeatureVS CodeGitHubHugo
Strikethrough✔️✔️✔️*

Hugo: requires strikethrough = true.


Syntax

https://example.com

Compatibility

FeatureVS CodeGitHubHugo
Autolink URLs✔️✔️✔️*

Hugo: requires linkify = true.


12. Footnotes

Syntax

Here is a footnote.[^1]

[^1]: Footnote text.

Compatibility

FeatureVS CodeGitHubHugo
Footnotes✔️✔️*

Hugo: requires footnote = true.


13. Inline HTML

Syntax

<div class="note">Hello</div>

Compatibility

FeatureVS CodeGitHubHugo
Inline HTML✔️✔️✔️*

Hugo: requires unsafe = true.


14. Emoji Shortcodes

Syntax

:smile:

Compatibility

FeatureVS CodeGitHubHugo
Emoji shortcodes✔️✔️

15. Horizontal Rule

Syntax

---

Compatibility

FeatureVS CodeGitHubHugo
Horizontal rules✔️✔️✔️

16. Definition Lists (Not GFM)

Syntax

Term
: Definition

Compatibility

FeatureVS CodeGitHubHugo
Definition lists

17. Front Matter (Hugo Only)

Syntax

---
title: "My Page"
date: 2025-01-01
---

Compatibility

FeatureVS CodeGitHubHugo
Front matterPreview onlyShows as code✔️

Summary


Tags: