Feuille de triche Markdown

Étape 1 / 3 33%

Choisissez un thème Markdown

Commencez par un groupe d’exemples, puis ouvrez la référence complète.

La syntaxe Markdown essentielle, classée par catégorie et présentée avec une source prête à copier ainsi que la sortie d’un véritable analyseur. Elle couvre les bases de CommonMark (titres, listes, emphase, liens, images et blocs de code délimités) et les extensions de GitHub Flavored Markdown (tableaux, listes de tâches, texte barré et création automatique de liens pour les URL brutes). Gardez-la sous la main lorsque vous passez de GitHub à GitLab, Obsidian ou un générateur de site statique.

Comment utiliser la feuille de triche

  1. 1

    Parcourir par catégorie

    Filtrez toute la référence ou choisissez un thème dans le parcours guidé.

  2. 2

    Comparer source et résultat

    Chaque exemple montre le Markdown brut à côté de la sortie d’un véritable analyseur GFM.

  3. 3

    Copier le snippet

    Appuyez sur copier pour récupérer le code source de tout exemple.

  4. 4

    Vérifier l’étiquette de syntaxe

    Chaque exemple est identifié comme CommonMark ou GitHub Flavored Markdown (GFM).

Titres

# Titre H1
## Section H2
### Sous-section H3

Utilisez le style ATX (#) plutôt que Setext (=== sous le texte). Chaque analyseur prend en charge les deux, mais ATX est plus facile à lire dans un diff.

Emphase

*italique* ou _italique_, **gras** ou __gras__, ***gras italique***. GFM ajoute ~~barré~~.

Listes

Les listes non ordonnées utilisent -, * ou + (choisissez-en un et tenez-vous-y) :

- Premier
- Deuxième
  - Imbriqué (deux espaces)

Les listes ordonnées se renumérotent automatiquement :

1. Élément
1. Élément
1. Élément

Code

En ligne : `code`. Blocs délimités avec balise de langue optionnelle :

```python
def hello(name):
    return f"Bonjour, {name}"
```

Indentez avec quatre espaces pour un bloc de code si vous préférez l’ancienne syntaxe.

Liens et images

[Texte du lien](https://example.com)
[Liens avec titre](https://example.com "Info-bulle")
![Texte alternatif](/path/to/image.png)

Le style de référence garde les longues URLs hors du paragraphe :

Voir les [docs][1].

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

Tableaux (GFM)

| Col A | Col B |
|-------|------:|
| a     |     1 |
| b     |    22 |

L’alignement utilise des deux-points dans la ligne de séparation : :--- à gauche, :---: au centre, ---: à droite.

Listes de tâches (GFM)

- [x] Fait
- [ ] À faire

Pièges courants

  • Deux espaces finaux insèrent un saut de ligne dans un paragraphe. Un espace ne fait que joindre les lignes.
  • Ligne vide requise avant la plupart des éléments de bloc (titres, listes, blocs de code).
  • Ne pas indenter les marqueurs de liste avec des tabulations si votre rendu attend des espaces ; indentez avec deux ou quatre espaces.
  • Échapper avec un antislash pour la ponctuation littérale : \*pas italique\*.
  • Guillemets intelligents diffèrent selon le rendu. GitHub les laisse tels quels ; Pandoc les convertit.

Questions fréquentes

CommonMark définit le socle portable, notamment les titres, listes, liens et blocs de code délimités avec une chaîne d’information facultative. GFM ajoute les tableaux, listes de tâches, textes barrés et liens automatiques pour les URL brutes. D’autres éditeurs peuvent n’en prendre en charge qu’une partie ou ajouter leurs propres extensions.

Dans un fichier Markdown, un seul retour à la ligne est généralement souple. Pour forcer un saut de ligne dans CommonMark ou GFM, terminez la première ligne par deux espaces ou une barre oblique inverse.

CommonMark reconnaît le HTML brut, mais la plateforme décide de l’autoriser, de le nettoyer ou de l’échapper. GitHub nettoie le HTML rendu et cet aide-mémoire l’échappe dans les aperçus par sécurité.

CommonMark ne définit aucune syntaxe de table des matières. GitHub crée des ancres de titres et affiche un plan pour les fichiers comportant plusieurs titres. Les autres plateformes ont leurs propres règles : MkDocs peut utiliser [TOC] avec l’extension correspondante, tandis que Docusaurus construit la table des matières à partir des titres.

Les exemples CommonMark et de nombreux exemples GFM fonctionnent. Obsidian prend aussi en charge ses propres wikiliens ([[Nom de la page]]), encadrés et contenus intégrés ; ces extensions ne figurent pas dans cet aide-mémoire.

Outils similaires