Qu'est-ce que Markdown et comment l'utiliser ?

Markdown est un langage de balisage léger qui vous permet de créer du texte formaté en utilisant un éditeur de texte brut. Créé à l'origine par John Gruber en 2004, Markdown est largement utilisé pour la documentation, les blogs, la prise de notes, et même le formatage de contenu dans les sites web et les applications.

Dans cet article, nous allons couvrir ce qu'est Markdown, où il est couramment utilisé, et comment appliquer ses fonctionnalités de formatage les plus essentielles.

Qu'est-ce que Markdown ?

Markdown est un moyen simple de styliser du texte sur le web. Au lieu d'utiliser des balises HTML complexes ou des éditeurs WYSIWYG, Markdown permet aux utilisateurs d'écrire en utilisant une syntaxe de texte brut lisible qui est ensuite convertie en HTML.

Par exemple, pour mettre du texte en gras, vous l'entourez simplement de doubles astérisques comme **ceci**, et pour créer une liste, vous pouvez utiliser des tirets ou des chiffres.

Markdown est populaire pour son équilibre entre simplicité et flexibilité, le rendant accessible aux utilisateurs techniques et non techniques.

Cas d'utilisation courants de Markdown

Markdown est utilisé dans de nombreux endroits où le texte brut doit être stylisé ou structuré.

Documentation technique

Les développeurs et les rédacteurs techniques utilisent souvent Markdown pour écrire de la documentation en raison de sa lisibilité et de son intégration facile avec les systèmes de contrôle de version comme Git.

Fichiers README dans GitHub

GitHub prend en charge nativement Markdown pour les fichiers README et la documentation. C'est le format par défaut pour introduire et expliquer un projet.

Blogs et rédaction de contenu

De nombreux générateurs de sites statiques modernes comme Jekyll, Hugo et Next.js prennent en charge Markdown pour la création de contenu. Il est également utilisé par des plateformes de blogs comme Ghost et Dev.to.

Applications de prise de notes

Des applications comme Obsidian, Notion (prise en charge partielle) et Bear permettent aux utilisateurs d'écrire des notes en utilisant la syntaxe Markdown pour un formatage facile.

Formatage d'e-mails et messagerie

Certains clients de messagerie et plateformes de messagerie (comme Slack et Discord) autorisent une syntaxe Markdown partielle pour le formatage de base comme le gras, l'italique ou les blocs de code.

Syntaxe de base de Markdown et comment l'utiliser

La syntaxe de Markdown est simple et lisible. Voici les éléments les plus courants dont vous aurez besoin.

Titres

Utilisez des symboles # pour créer des titres. Le nombre de symboles # correspond au niveau de titre.

# H1 - Titre principal
## H2 - Titre de section
### H3 - Titre de sous-section

Emphase

Vous pouvez mettre en évidence le texte avec de l'italique ou du gras :

*Texte en italique* ou _Texte en italique_
**Texte en gras** ou __Texte en gras__
***Gras et italique*** ou ___Gras et italique___

Listes

Markdown prend en charge les listes non ordonnées et ordonnées.

  • Liste non ordonnée :

    - Élément 1
- Élément 2
  - Sous-élément

  • Liste ordonnée :

    1. Premier élément
2. Deuxième élément
   1. Élément imbriqué

Liens

Pour ajouter un hyperlien, utilisez des crochets pour le texte et des parenthèses pour l'URL :

[Visitez OpenAI](https://www.openai.com)

Images

Les images utilisent la même syntaxe que les liens, mais commencent par un point d'exclamation :

![Texte alternatif](https://example.com/image.png)

Citations en bloc

Pour créer une citation en bloc, préfixez la ligne avec > :

> Ceci est une citation en bloc.

Code et blocs de code

Pour le code en ligne, entourez le texte de guillemets inversés :

Utilisez la fonction `console.log()`.

Pour les blocs de code multilignes, utilisez trois guillemets inversés :

```javascript
function greet(name) {
  return `Bonjour, ${name}`;
}
```

Règle horizontale

Utilisez trois tirets, astérisques ou underscores ou plus pour créer une ligne horizontale :

---

Tableaux

Les tableaux Markdown utilisent des barres verticales et des tirets :

| Syntaxe | Description |
|--------|-------------|
| En-tête | Titre       |
| Cellule | Contenu     |

Conseils pour écrire en Markdown

  • Utilisez un outil de prévisualisation Markdown (tel que VS Code, Typora ou StackEdit) pour visualiser instantanément le résultat.
  • Lorsque vous rédigez des documents plus longs, organisez vos sections à l’aide d’en-têtes appropriés.
  • Utilisez une mise en forme cohérente pour maintenir la clarté.
  • Utilisez des commentaires (de style HTML <!-- Commentaire -->) pour laisser des notes qui n’apparaîtront pas dans le résultat final.