Aller au contenu principal

Le langage MarkDown

Que ce soit pour rédiger des articles de blog, créer des documents techniques, collaborer sur des projets en ligne ou tout simplement échanger des messages, le texte est omniprésent. Cependant, avec cette omniprésence du texte, il est essentiel de disposer d'un moyen simple et efficace pour le formater et le structurer de manière à le rendre lisible, compréhensible et esthétiquement plaisant.

C'est là qu'intervient le langage Markdown.

Qu'est-ce que Markdown ?​

Markdown est un langage de balisage léger conçu pour simplifier la mise en forme du texte en utilisant une syntaxe minimaliste. Il a été créé pour permettre aux auteurs de se concentrer sur le contenu plutôt que sur la mise en page, en offrant une manière simple et intuitive d'ajouter des éléments de mise en forme à leur texte.

Le langage MarkDown a été créé en 2004 par John Gruber et Aaron Swartz1. Ils se sont fixés comme objectif de définir une syntaxe simple à lire et à écrire en l'état dans sa forme non formatée.

Les Éléments de Base​

Commençons par explorer les éléments de base de Markdown que vous utiliserez fréquemment dans vos documents.

Titres et Sous-titres​

Markdown prend en charge six niveaux de titres, allant de # pour les titres de premier niveau (h1) à ###### pour les titres de sixième niveau (h6). Par exemple :

## Titre de Deuxième Niveau (h2)
### Titre de Troisième Niveau (h3)

Texte en Gras et en Italique​

Pour mettre en gras un morceau de texte, entourez-le de deux astérisques ** ou de deux traits de soulignement __. Par exemple, **ceci est en gras** devient ceci est en gras et __ceci est aussi en gras__ est également converti en ceci est aussi en gras.

Pour mettre en italique, utilisez un astérisque * ou un trait de soulignement _. Par exemple, *ceci est en italique* devient ceci est en italique, et _ceci est aussi en italique_ est également converti en ceci est aussi en italique.

Liens Hypertextes​

Pour créer un lien hypertexte, utilisez la syntaxe suivante :

[Texte du lien](URL du lien)

Par exemple, [Le blog de Stéphane](https://blog.stephane-robert.info/) générera un lien vers mon blog : Le blog de Stéphane.

Listes à Puces et Numérotées​

Pour créer une liste à puces, commencez chaque élément de la liste par un astérisque *, un trait d'union -, ou un signe plus +. Par exemple :

* Élément 1
* Élément 2
* Élément 3

Cela donnera :

  • Élément 1
  • Élément 2
  • Élément 3

Pour créer une liste numérotée, commencez chaque élément de la liste par un nombre suivi d'un point. Par exemple :

1. Premier élément
2. Deuxième élément
3. Troisième élément

Cela se transforme en :

  1. Premier élément
  2. Deuxième élément
  3. Troisième élément

Les Citations​

Les citations sont un autre outil utile pour améliorer la lisibilité de votre texte et pour citer des sources ou des références. Vous pouvez les créer en utilisant le caractère > suivi du texte cité. Par exemple :

> Voici une citation dans Markdown. Elle peut être utilisée pour insérer des citations célèbres, des extraits de texte, ou pour mettre en évidence des informations importantes.

Cela se traduit par :

Voici une citation dans Markdown. Elle peut être utilisée pour insérer des citations célèbres, des extraits de texte, ou pour mettre en évidence des informations importantes.

Les blocs de citation sont également utiles pour distinguer visuellement le texte cité du reste de votre contenu.

Les Notes de Bas de Page​

Les notes de bas de page sont une manière élégante d'ajouter des informations complémentaires à votre document sans interrompre la lecture principale. Pour insérer une note de bas de page, suivez ces étapes :

  1. Créez un lien vers la note en utilisant un crochet [^] suivi d'un identifiant unique (par exemple, [^1]).
  2. À la fin de votre document, créez une section distincte pour les notes de bas de page et associez chaque identifiant unique à son contenu explicatif.

Par exemple :

Voici un texte avec une note de bas de page[^1].

[^1]: Note de bas de page 1

Ce qui donne :

Voici un texte avec une note de bas de page1.

Lorsque le lecteur clique sur le lien 1, il est dirigé vers la note de bas de page correspondante.

Conclusion​

Markdown évolue constamment grâce à la contribution de la communauté open source. De nouvelles extensions et fonctionnalités sont régulièrement ajoutées pour répondre aux besoins changeants des utilisateurs. Il s'agit donc d'un langage qui continue de s'améliorer au fil du temps.

Quelques variantes de ce langage : MultiMarkdown, GitHub Flavored Markdown (GFM), Pandoc, CommonMark, Markdown Extra, ...

Le langage Markdown est un outil précieux pour tous ceux qui souhaitent communiquer de manière efficace sur le web. En investissant du temps dans son apprentissage, vous pouvez améliorer la qualité de votre contenu, simplifier votre flux de travail de rédaction et atteindre un public plus large.

attention

En tant que consultant DevSecOps, vous devrez écrire de la documentation. Le markdown peut être stocké dans des dépôts git ce qui permet de faire de la doc-as-code.

Plus d'infos​

Sites​

Footnotes​

  1. Note de bas de page 1 ↩