1. Accueil
  2. Blog
  3. Guide

Aide-mémoire Markdown : la syntaxe GitHub avec exemples

Un aide-mémoire Markdown pratique : titres, listes, liens, images, code, tableaux, listes de tâches, encadrés et notes, avec des exemples GFM prêts à copier.

Le Markdown est le moyen le plus simple d’écrire du texte mis en forme qui reste lisible en texte brut. Fichiers README, documentation, notes, messageries et sites statiques : tout le monde l’utilise. Cet aide-mémoire couvre la syntaxe dont vous vous servirez vraiment, en mettant l’accent sur le GitHub-Flavored Markdown (GFM) — le dialecte pris en charge par GitHub, GitLab, la plupart des outils de documentation et Markdown Preview Editor.

Chaque exemple ci-dessous peut être collé dans l’éditeur en ligne pour voir le résultat côte à côte.

Titres

Commencez une ligne par un à six caractères # suivis d’une espace. Un seul # pour le titre de la page, ## pour une section, ### pour une sous-section.

markdown# Titre de la page
## Section
### Sous-section
#### Titre plus petit

Gardez un seul titre # par document et ne sautez pas de niveau (par exemple de ## directement à ####). Les lecteurs d’écran et les moteurs de recherche s’appuient sur la structure des titres pour comprendre la page, et la plupart des outils d’aperçu en tirent une table des matières.

Paragraphes et retours à la ligne

Un paragraphe est constitué d’une ou plusieurs lignes de texte, séparées des autres par une ligne vide. Un simple retour à la ligne à l’intérieur d’un paragraphe est ignoré : les lignes sont fusionnées. Pour forcer un retour à la ligne, terminez la ligne par deux espaces ou une barre oblique inverse :

markdownPremière ligne avec deux espaces à la fin  
Deuxième ligne dans le même paragraphe.

Un nouveau paragraphe commence après une ligne vide.

Mise en valeur

Vous tapez Vous obtenez
*italique* ou _italique_ italique
**gras** ou __gras__ gras
***gras italique*** gras italique
~~barré~~ barré
`code en ligne` code en ligne

De nombreux éditeurs, dont Markdown Preview Editor, prennent aussi en charge quelques extensions populaires : ==surlignage==, H~2~O pour l’indice, x^2^ pour l’exposant et les codes emoji de type :smile:. Elles ne font pas partie du GFM lui-même : vérifiez votre plateforme cible avant de compter dessus.

Listes

Utilisez -, * ou + pour les listes à puces et des nombres pour les listes numérotées. Indentez de deux à quatre espaces pour imbriquer des éléments.

markdown- Lait
- Pain
  - Complet
  - Seigle
- Café

1. Cloner le dépôt
2. Installer les dépendances
3. Lancer le build

Les listes numérotées n’ont pas besoin des bons numéros : 1. sur chaque ligne s’affiche quand même 1, 2, 3. Commencer par un autre nombre (par exemple 5.) fait démarrer la liste à ce nombre.

Listes de tâches

Les listes de tâches sont une extension GFM qui transforme les éléments d’une liste en cases à cocher. Parfaites pour les README, les plans de publication et les comptes rendus de réunion.

markdown- [x] Rédiger le brouillon
- [x] Ajouter des captures d’écran
- [ ] Publier l’article

Liens

markdown[Texte du lien](https://example.com)
[Lien avec un titre](https://example.com "Affiché au survol")
<https://example.com>

Lisez le [guide d’installation][install].

[install]: https://example.com/docs/install

La dernière forme est un lien de référence : l’URL est définie une seule fois en bas du document, ce qui garde les longs paragraphes lisibles. Les liens relatifs comme [Setup](docs/setup.md) pointent vers d’autres fichiers du même projet ; dans Markdown Preview Editor, ils basculent vers ce document s’il est ouvert dans un autre onglet.

Images

Les images reprennent la syntaxe des liens, précédée d’un point d’exclamation. Le texte entre crochets est le texte alternatif : décrivez l’image pour les personnes qui ne peuvent pas la voir.

markdown![Éditeur avec aperçu en direct](images/screenshot.png)
![Logo](https://example.com/logo.svg "Titre facultatif")

Pour prévisualiser un document qui fait référence à des images locales, ouvrez le dossier entier ou déposez les images avec le fichier .md, afin que l’outil d’aperçu puisse résoudre les chemins relatifs.

Code

Le code en ligne utilise des accents graves simples. Pour un bloc, entourez le code de trois accents graves et ajoutez le nom du langage pour la coloration syntaxique :

markdown```js
function greet(name) {
  return `Hello, ${name}!`;
}
```

Noms de langages courants : js, ts, python, bash, json, yaml, html, css, sql, go, rust, diff. Si votre code contient lui-même trois accents graves, délimitez-le avec quatre, comme dans l’exemple ci-dessus.

Tableaux

Séparez les colonnes par des barres verticales et placez une ligne de tirets sous l’en-tête. Les deux-points dans la ligne de séparation fixent l’alignement.

markdown| Fonction  | Gratuit | Remarques                 |
|:----------|:-------:|--------------------------:|
| Aperçu    |   ✅    | Mis à jour pendant la frappe |
| Export    |   ✅    | HTML, PDF, .md            |

:--- aligne à gauche, :---: centre et ---: aligne à droite. Les colonnes n’ont pas besoin d’être alignées dans la source, mais un bon éditeur les garde lisibles. Markdown Preview Editor propose dans sa barre d’outils un bouton Tableau qui insère un modèle prêt à l’emploi.

Citations et encadrés

Préfixez les lignes par > pour citer du texte. GitHub prend aussi en charge les encadrés (alerts) : des citations dont la première ligne spéciale les transforme en blocs colorés :

markdown> Une citation ordinaire.

> [!NOTE]
> Information utile que les utilisateurs doivent connaître.

> [!TIP]
> Conseil pratique pour mieux faire les choses.

> [!WARNING]
> Information urgente qui demande une attention immédiate.

Les cinq types d’encadrés sont NOTE, TIP, IMPORTANT, WARNING et CAUTION. Utilisez-les avec parcimonie : un encadré par section attire l’œil, cinq à la suite deviennent du bruit.

Notes de bas de page

Les notes de bas de page sortent les remarques annexes du texte principal. La note peut être définie n’importe où ; elle s’affiche à la fin du document.

markdownMarkdown a été créé en 2004.[^1]

[^1]: Par John Gruber, avec l’aide d’Aaron Swartz.

Lignes horizontales et échappement

Trois tirets, astérisques ou tirets bas (ou plus) seuls sur une ligne créent une ligne horizontale : ---. Placez une ligne vide avant, sinon --- sous une ligne de texte transforme ce texte en titre.

Pour afficher un caractère que le Markdown interpréterait, échappez-le avec une barre oblique inverse : \*pas en italique\*, \# pas un titre, \$5 (utile quand les formules sont activées).

Formules et diagrammes

Deux extensions sont devenues la norme en rédaction technique :

Front matter

Les générateurs de sites statiques lisent des métadonnées dans un bloc YAML tout en haut du fichier :

yaml---
title: Mon article
date: 2026-09-27
tags: [markdown, docs]
---

Un bon outil d’aperçu masque ce bloc au lieu de l’afficher comme du texte. C’est exactement ce que fait Markdown Preview Editor.

Pour aller plus loin

Connaître la syntaxe, c’est la moitié du travail ; l’autre moitié, c’est voir le résultat pendant que vous écrivez. Découvrez comment prévisualiser du Markdown en ligne sans envoyer vos fichiers, puis, une fois votre document prêt, comment convertir du Markdown en HTML ou en PDF.

Questions fréquentes

Quelle est la différence entre Markdown et GitHub-Flavored Markdown ?

Le Markdown original (2004) définissait les bases : titres, mise en valeur, listes, liens, images, code et citations. Le GitHub-Flavored Markdown est une spécification stricte fondée sur CommonMark, qui ajoute tableaux, listes de tâches, texte barré, liens automatiques et notes de bas de page. La plupart des outils modernes suivent le GFM.

Comment aller à la ligne en Markdown sans créer de nouveau paragraphe ?

Terminez la ligne par deux espaces ou une barre oblique inverse (\). Un simple retour à la ligne à l’intérieur d’un paragraphe est traité comme une espace.

Comment ajouter une table des matières en Markdown ?

Le Markdown n’a pas de syntaxe intégrée pour la table des matières. Vous pouvez en écrire une à la main avec des liens vers les ancres des titres, comme [Tables](#tables). De nombreux outils génèrent automatiquement les ancres à partir des titres, et Markdown Preview Editor propose un bouton Table des matières dans sa barre Éditeur avancé qui construit la liste pour vous.

Peut-on utiliser du HTML dans du Markdown ?

De nombreux moteurs de rendu acceptent une partie du HTML, mais les plateformes suppriment tout ce qui pourrait être dangereux, comme les scripts et les gestionnaires d’événements en ligne. Pour des documents portables, préférez la syntaxe Markdown pure dès qu’elle permet d’exprimer ce dont vous avez besoin.