Markup

Markdown Cheatsheet

Quick reference for Markdown syntax including headings, lists, links, images, code blocks, tables, footnotes, and extensions.

Headings

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

Text Formatting

SyntaxResult
**bold**bold
*italic*italic
***bold italic***bold italic
~~strikethrough~~strikethrough
`inline code`inline code
> blockquoteblockquote
--- or ***Horizontal rule
[Link text](https://example.com)
[Link with title](https://example.com "Title")
<https://example.com>
[Reference link][ref]

[ref]: https://example.com

Images

![Alt text](image.png)
![Alt text](image.png "Title")
[![Clickable image](image.png)](https://example.com)

Lists

Unordered

- Item 1
- Item 2
  - Nested item
  - Nested item
- Item 3

Ordered

1. First item
2. Second item
   1. Nested item
3. Third item

Task Lists (GFM)

- [x] Completed task
- [ ] Incomplete task
- [ ] Another task

Code

Inline

Use `code` in a sentence.

Fenced Code Block

```javascript
function hello() {
  console.log("Hello!");
}
```

Indented Code Block

    function hello() {
      console.log("Hello!");
    }

Tables

| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Cell 1   | Cell 2   | Cell 3   |
| Cell 4   | Cell 5   | Cell 6   |

Alignment

| Left   | Center  | Right  |
|:-------|:-------:|-------:|
| Left   | Center  | Right  |

Blockquotes

> Single line quote

> Multi-line quote
> continues here

> Nested quote
>> Inner quote

Footnotes

Here is a statement[^1].

[^1]: This is the footnote content.

Definition Lists (some parsers)

Term
: Definition of the term

Escaping

Use backslash to escape special characters:

\* \_ \# \[ \] \( \) \` \~ \> \| \\

HTML in Markdown

<details>
<summary>Click to expand</summary>

Hidden content here.

</details>

<kbd>Ctrl</kbd> + <kbd>C</kbd>

<sup>superscript</sup> and <sub>subscript</sub>

GitHub Flavored Markdown Extras

Alerts

> [!NOTE]
> Useful information.

> [!TIP]
> Helpful advice.

> [!WARNING]
> Important warning.

> [!CAUTION]
> Critical information.

Auto-linked References

@username                    <!-- Mention -->
#123                         <!-- Issue/PR -->
SHA: a1b2c3d                <!-- Commit -->

Emoji

:smile: :rocket: :thumbsup:

Math (GitHub)

Inline: $E = mc^2$

Block:
$$
\sum_{i=1}^{n} x_i
$$