Markdown Specs

Published: 27 June 2026 | Last edited: 27 June 2026

Markdown is a lightweight markup language used to format text. It is commonly used for documentation, README files, and notes. Here's a quick overview of its main features.

Markdown logo

1. Headings

Use # symbols for headings. The number of # signs determines the level.

# H1

## H2

### H3

#### H4

H1

H2

H3

H4

2. Emphasis

Use asterisks or underscores:

3. Lists

Unordered List

- Item 1
- Item 2
  - Subitem 2.1
  - Subitem 2.2

Ordered List

1. First
2. Second
   1. Sub-step
  1. First

  2. Second

    1. Sub-step
[example.com](https://www.example.com)

example.com

5. Images

![Alt Text](https://via.placeholder.com/150)

Markdown Logo

6. Code

Inline code: `code` → Example: print("Hello World")

Code blocks:

```python
def greet():
    print("Hello, Markdown!")
```
def greet():
    print("Hello, Markdown!")

7. Blockquotes

> This is a blockquote.

This is a blockquote.

You know you’re getting old when you get that one candle on the cake. It’s like, ‘See if you can blow this out.‘

8. Horizontal Rule

Three dashes, asterisks, or underscores:

---

9. Tables

| Name  | Role      |
| ----- | --------- |
| Alice | Developer |
| Bob   | Designer  |
NameRole
AliceDeveloper
BobDesigner

10. Task Lists

---

Use `- [ ]` for a checkbox.

```markdown
- [x] Write basic Markdown
- [ ] Learn advanced features
- [ ] Conquer the world

List of things I want to get done.

11. Footnotes

Add extra information without cluttering your main text.1

This is a sentence with a footnote.[^1]

[^1]: Here's the footnote!

12. Tables with Alignment

You can align text left, center, or right using colons (:).

| Name     | Role       | Score |
|:---------|:----------:|------:|
| Alice    | Developer  |    95 |
| Bob      | Designer   |    87 |
| Charlie  | **Manager**|   100 |
NameRoleScore
AliceDeveloper95
BobDesigner87
CharlieManager100

13. Collapsible Sections (HTML only)

<details>
  <summary>Click to expand!</summary>
  Hidden content goes here. You can include **Markdown** inside!
</details>
Click to expand! Hidden content goes here. You can include **Markdown** inside!

14. Strikethrough

Use ~~text~~ to strike through.

~~This text is crossed out~~

This text is crossed out

15. Inline HTML

Markdown allows some HTML:

<b>Bold HTML</b> <i>Italic HTML</i> <span style="color:red">Red Text</span>

Bold HTML Italic HTML Red Text

16. Math (LaTeX)

Use dollar signs for inline math: $E = mc^2$ Or double for blocks:

$$
\int_0^\infty e^{-x^2} dx = \frac{\sqrt{\pi}}{2}
$$

inline: E=mc2E = mc^2

0ex2dx=π2\int_0^\infty e^{-x^2} dx = \frac{\sqrt{\pi}}{2}

URLs and emails become links automatically:

https://www.example.com  
[email protected]

https://www.exmaple.com
[email protected]

18. Alerts

> [!NOTE]
> Useful information that users should know, even when skimming content.

> [!TIP]
> Helpful advice for doing things better or more easily.

> [!IMPORTANT]
> Key information users need to know to achieve their goal.

> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.

> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.

NOTE

Useful information that users should know, even when skimming content.

TIP

Helpful advice for doing things better or more easily.

IMPORTANT

Key information users need to know to achieve their goal.

WARNING

Urgent info that needs immediate user attention to avoid problems.

CAUTION

Advises about risks or negative outcomes of certain actions.

Footnotes

  1. Here’s the footnote!