Overview

Markdown is a simple language used for text formatting. It allows you to obtain an elegant, visually attractive text just by writing a plain text document. It’s widely used due to its simplicity and ease of use, making it a popular choice for:

  • creating documentation
  • writing blog posts
  • text formatting in various applications, e.g. Jupyter Notebook

and more.

Markdown syntax covers many common text formatting elements, such as:

  • headings
  • bullet lists
  • links
  • images embedding
  • bold, italic
  • code formatting

and much more.

Use cases

Below you can find some examples of tools and services which support Markdown:

  • Jupyter Notebook / Jupyter Lab
  • static sites generators (blogs, documentations, this website etc.)
  • README files in Git repositories
  • note taking apps (Notion, Obsidian etc.)

Basic syntax

If you want to learn Markdown, check out https://www.markdownguide.org/ website. Below I listed the most common Markdown syntax elements:

1. Headings

Raw text:

1
2
3
4
5

# First heading (H1)

## Second heading (H2)

### Third heading (H3)

Preview:

First heading (H1)

Second heading (H2)

Third heading (H3)

2. Bullet lists

Raw text:

1
2
3

- first item
- second item
- third item

Preview:

  • first item
  • second item
  • third item

Raw text:

1

[Click this](https://patrykpalej.dev)

Preview:

Click this

4. Images

Raw text:

1

![image alt text](https://s3.dualstack.us-east-2.amazonaws.com/pythondotorg-assets/media/community/logos/python-logo-only.png)

Preview:

image alt text

5. Bold, italic

Raw text:

1
2
3
4
5
6
7

**bold text**

*italic text*

_also italic text_

***bold and italic text***

Preview:

bold text

italic text

also italic text

bold and italic text