Skip to main content

Markdown Reference

Browse Markdown syntax with side-by-side rendered previews and GFM extensions.

37 entries found

Heading 1
basics

Markdown

# Heading 1

Rendered

Heading 1

Heading 2
basics

Markdown

## Heading 2

Rendered

Heading 2

Heading 3
basics

Markdown

### Heading 3

Rendered

Heading 3

Bold
basics

Markdown

**bold text**

Rendered

bold text

Italic
basics

Markdown

_italic text_

Rendered

italic text

Bold & Italic
basics

Markdown

***bold italic***

Rendered

bold italic

StrikethroughGFM
basics

Markdown

~~strikethrough~~

Rendered

strikethrough

Horizontal Rule
basics

Markdown

---

Rendered


Paragraph
basics

Markdown

Line one

Line two (empty line = new paragraph)

Rendered

Line one

Line two

Line Break
basics

Markdown

End with two spaces  
or use backslash\

Rendered

End with two spaces
or use backslash

Inline Link
links

Markdown

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

Rendered

Link with Title
links

Markdown

[Text](https://example.com "Tooltip")

Rendered

Reference Link
links

Markdown

[Link text][ref]

[ref]: https://example.com

Rendered

Auto Link
links

Markdown

<https://example.com>
Image
links

Markdown

![Alt text](image.png)

Rendered

Browser won't load relative path in preview

Unordered List
lists

Markdown

- Item one
- Item two
- Item three

Rendered

  • Item one
  • Item two
  • Item three
Ordered List
lists

Markdown

1. First
2. Second
3. Third

Rendered

  1. First
  2. Second
  3. Third
Nested List
lists

Markdown

- Parent
  - Child
    - Grandchild

Rendered

  • Parent
    • Child
      • Grandchild
Task ListGFM
lists

Markdown

- [x] Done
- [ ] Todo
- [ ] Also todo

Rendered

  • Done
  • Todo
Inline Code
code

Markdown

Use `code` here

Rendered

Use code here

Fenced Code Block
code

Markdown

```javascript
console.log('hello');
```

Rendered

console.log('hello');
Indented Code Block
code

Markdown

    // 4-space indent
    const x = 1;

Rendered

// 4-space indent
const x = 1;
Basic TableGFM
tables

Markdown

| Column A | Column B |
|----------|----------|
| Cell 1   | Cell 2   |

Rendered

Column AColumn B
Cell 1Cell 2
Column AlignmentGFM
tables

Markdown

| Left | Center | Right |
|:-----|:------:|------:|
| A    |   B    |     C |

Rendered

LeftCenterRight
ABC
Blockquote
blockquotes

Markdown

> This is a quote.
> It can span lines.

Rendered

This is a quote. It can span lines.

Nested Blockquote
blockquotes

Markdown

> Outer
>> Inner
>>> Deeper

Rendered

Outer

Inner

Deeper

Alert: NoteGFM
gfm

Markdown

> [!NOTE]
> Highlights information.

Rendered

GitHub-flavored Markdown alert

Alert: TipGFM
gfm

Markdown

> [!TIP]
> Helpful advice.

Rendered

Renders as a styled callout on GitHub

Alert: WarningGFM
gfm

Markdown

> [!WARNING]
> Critical content.

Rendered

Styled warning callout (GitHub only)

User MentionGFM
gfm

Markdown

@username

Rendered

Links to GitHub user profile

Issue ReferenceGFM
gfm

Markdown

#123

Rendered

Links to issue or PR #123

FootnoteGFM
gfm

Markdown

Text[^1]

[^1]: Footnote text.

Rendered

Text<sup><a>1</a></sup>

Front Matter (YAML)
advanced

Markdown

---
title: My Doc
date: 2025-01-01
---

Rendered

Not rendered as Markdown — used by static site generators

Inline HTML
advanced

Markdown

<span style="color:red">Red text</span>

Rendered

Red text
Escape Characters
advanced

Markdown

\*literal asterisk\*

Rendered

*literal asterisk*

HTML Comment
advanced

Markdown

<!-- This is a comment -->

Rendered

<!-- (hidden in rendered output) -->

Definition List
advanced

Markdown

Term
: Definition

Rendered

Term
Definition