Aide-mémoire Markdown
Référence rapide de la syntaxe Markdown — titres, listes, liens, blocs de code, tableaux et plus, avec aperçus rendus en temps réel.
Comment Utiliser
- Naviguez dans la table des matières à gauche pour accéder à n'importe quelle catégorie de syntaxe.
- Chaque carte affiche la syntaxe Markdown brute à gauche et le résultat rendu à droite.
- Cliquez sur le bouton Copier pour copier l'extrait dans votre presse-papiers.
- Utilisez directement ces extraits dans GitHub, Notion, VS Code, Obsidian ou n'importe quel éditeur Markdown.
Questions Fréquentes
-
Qu'est-ce que Markdown ?
Markdown est un langage de balisage léger créé par John Gruber en 2004. Il permet d'écrire du texte formaté en utilisant des symboles de texte brut — par exemple, entourer du texte avec ** le met en gras. Les fichiers Markdown sont convertis en HTML par les rendus utilisés dans GitHub, les plateformes de blogs, les outils de documentation et les applications de prise de notes.
-
La syntaxe Markdown est-elle identique partout ?
La syntaxe de base est largement cohérente, mais différentes plateformes prennent en charge différentes extensions. GitHub Flavored Markdown (GFM) ajoute des listes de tâches, le barré et les tableaux. Obsidian prend en charge les wikilinks. Certaines plateformes utilisent CommonMark comme standard. Cet aide-mémoire se concentre sur les fonctionnalités les plus largement prises en charge.
-
Comment faire un saut de ligne en Markdown ?
Terminez une ligne avec deux espaces puis appuyez sur Entrée pour créer un saut de ligne doux. Pour un saut de paragraphe, laissez une ligne vide entre deux lignes. Dans de nombreux rendus, un simple saut de ligne sans espaces finaux est traité comme un espace, pas comme un saut.
-
Peut-on utiliser du HTML dans Markdown ?
La plupart des rendus Markdown autorisent le HTML en ligne. Par exemple, vous pouvez utiliser <br> pour un saut de ligne, <u>texte</u> pour le soulignement, ou <details> pour des sections pliables. Cependant, le support varie — certains rendus axés sur la sécurité filtrent complètement le HTML.
Qu'est-ce que Markdown ?
Markdown est une syntaxe de texte brut qui se convertit en HTML. Créé par John Gruber en 2004, il a été conçu pour être lisible tel quel — le texte brut devrait ressembler à du texte formaté même sans rendu. Aujourd'hui, il est utilisé partout : README GitHub, documentation technique, plateformes de blogs, applications de prise de notes comme Obsidian et Notion, et outils de chat comme Slack et Discord.
L'idée centrale est simple : utiliser des caractères ordinaires pour indiquer la mise en forme. Un # avant une ligne en fait un titre. Entourer du texte avec ** le met en gras. Indenter une ligne avec quatre espaces en fait un bloc de code.
Comment un Aide-mémoire Markdown Aide
Même les écrivains expérimentés oublient parfois la syntaxe exacte pour aligner des colonnes dans un tableau, imbriquer des listes ou créer des blocs de code avec coloration syntaxique. Un aide-mémoire sert de référence rapide — vous voyez la syntaxe brute et le résultat rendu côte à côte.
Cet aide-mémoire couvre :
- Titres — quatre niveaux de h1 à h4
- Mise en forme du texte — gras, italique, barré, code en ligne, hyperliens
- Listes — ordonnées, non ordonnées, imbriquées et listes de tâches
- Liens et images — liens en ligne, liens avec titre, images
- Citations — simples et imbriquées
- Blocs de code — délimités avec option de langue pour la coloration syntaxique
- Tableaux — avec options d'alignement des colonnes
- Règles horizontales — comme séparateurs visuels
Dialectes Markdown
CommonMark est une spécification standardisée qui résout les ambiguïtés de la spécification originale. GitHub, GitLab, Discourse et beaucoup d'autres plateformes suivent CommonMark ou quelque chose de proche.
GitHub Flavored Markdown (GFM) ajoute des listes de tâches (- [x]), le barré (~~texte~~), des tableaux et des liens automatiques. La plupart des plateformes de code prennent en charge GFM ou un sur-ensemble de celui-ci.
Pour l'écriture technique quotidienne — README, documentation, articles de blog, notes — CommonMark standard plus les extensions GFM couvre pratiquement tout ce dont vous avez besoin.
Conseils pour Bien Écrire en Markdown
Soyez cohérent avec les marqueurs de liste. Choisissez - ou * pour les listes non ordonnées et restez-y. Les mélanger est valide mais plus difficile à lire en forme brute.
Utilisez des lignes vides entre les éléments de bloc. Une ligne vide avant et après les titres, blocs de code et citations assure un rendu correct dans différents analyseurs.
Préférez les blocs de code délimités aux blocs indentés. Les blocs à triple accent grave permettent de spécifier le langage pour la coloration syntaxique et sont visuellement plus clairs dans la source.
Utilisez un texte de lien descriptif. [Cliquez ici](url) est moins bon que [Spécification Markdown](url) pour la lisibilité et l'accessibilité.