Aller au contenu

Markdown

Markdown est un langage de balisage léger qui permet de formater du texte de manière simple et lisible, en utilisant une syntaxe facile à comprendre. Il a été créé par John Gruber (programmeur et influent blogueur tech) en 2004, avec la collaboration de Aaron Swartz, dans le but de faciliter l'écriture et la mise en forme de documents texte pour le web, en évitant le recours à des balises HTML.

La syntaxe Markdown est conçue pour être facile à écrire et à lire, même sous forme de texte brut. Elle permet de créer rapidement des documents formatés en ajoutant des balises légères, telles que des astérisques (*), des tirets (-), des crochets, des parenthèses, etc., pour indiquer des éléments tels que les titres, les listes, les liens hypertexte, les images, et bien d'autres.

Markdown est largement utilisé pour rédiger des documents, des articles de blog, des pages web et des documents de documentation, car il permet de créer rapidement du contenu formaté sans avoir à se soucier de la complexité de la syntaxe HTML. De nombreux éditeurs de texte et plates-formes de blogging prennent en charge Markdown, ce qui en fait un outil populaire parmi les rédacteurs et les développeurs web.

  • Un fichier texte écrit au format Markdown peut être converti en HTML, en PDF ou en d'autres formats.
  • Un fichier écrit en Markdown porte en général l'extension .md.
  • Ce format n'a jamais été formellement standardisé, il existe donc plusieurs variantes❗️
  • Ce format est très utilisé par les développeurs pour écrire divers fichiers spécifiques et est utilisé dans de multiples logiciels : CHANGELOG.md, README.md, Discord, Reddit, Trello, GitLab, GitHub, …

➡️ GitHub Markdown Cheatsheet

➡️ GitLab Flavored Markdown

🎁 Bonus pour ceux qui utilisent Discord : Markdown Text 101

Exemple

# My Markdown Document

This is an example of a document written in Markdown. Markdown is a lightweight
markup language that allows you to easily format text.
Here are some basic elements:

## Headings

You can create headings using one or more hashtags (#):

-   `# Level 1 Heading` for a main heading.
-   `## Level 2 Heading` for a subheading.
-   `### Level 3 Heading` for a sub-subheading, and so on.

## Lists

Bulleted lists are easy to create:

-   Item 1
-   Item 2
-   Item 3

Numbered lists are also supported:

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

## Text Formatting

You can make text _italic_ by enclosing it in single asterisks or underscores,
like `*italic*` or `_italic_`. For **bold** text, use double asterisks or
underscores, like `**bold**` or `__bold__`.

## Links

Hypertext links are created using the following syntax: `[link text](URL)`.

For example, here's a link to [OpenAI](https://www.openai.com/).

## Images

Images can be inserted in the same way as links, using `![alt text](image URL)`.

Here's an image of One Piece:
![One Piece](https://example.com/one-piece.png)

That's it for this example. Markdown is a quick and efficient way to write
structured content for the web.

Rendu

My Markdown Document

This is an example of a document written in Markdown. Markdown is a lightweight markup language that allows you to easily format text. Here are some basic elements:

Headings

You can create headings using one or more hashtags (#):

  • # Level 1 Heading for a main heading.
  • ## Level 2 Heading for a subheading.
  • ### Level 3 Heading for a sub-subheading, and so on.

Lists

Bulleted lists are easy to create:

  • Item 1
  • Item 2
  • Item 3

Numbered lists are also supported:

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

Text Formatting

You can make text italic by enclosing it in single asterisks or underscores, like *italic* or _italic_. For bold text, use double asterisks or underscores, like **bold** or __bold__.

Hypertext links are created using the following syntax: [link text](URL).

For example, here's a link to OpenAI.

Images

Images can be inserted in the same way as links, using ![alt text](image URL).

Here's an image of One Piece: One Piece

That's it for this example. Markdown is a quick and efficient way to write structured content for the web.