Menu
Coddy logo textTech

Aide-mémoire Markdown

Dernière mise à jour

Titres

Mettez un espace après les signes #. Le nombre de signes fixe le niveau, de 1 à 6.

ÉlémentMarkdownRendu
Titre 1# Page titleTitre de premier niveau, <h1>
Titre 2## SectionTitre de section, <h2>
Titre 3### SubsectionTitre de sous-section, <h3>
Titres 4 à 6#### Level 4 ##### Level 5 ###### Level 6<h4>, <h5> et <h6>
Titre 1, autre formePage title ==========<h1>, identique à # Page title
Titre 2, autre formeSection -------<h2>, identique à ## Section
Dièses de fermeture## Section ##<h2>Section</h2> ; les signes # finaux sont ignorés
Espace manquant#Not a headingUn paragraphe ordinaire. L'espace après # est obligatoire

Gras, italique et barré

Les astérisques fonctionnent partout, même au milieu d'un mot. Les tirets bas ne fonctionnent qu'en limite de mot, donc snake_case reste tel quel.

ÉlémentMarkdownRendu
Gras**bold text**Gras, <strong>bold text</strong>
Gras, tirets bas__bold text__Gras, identique au précédent
Italique*italic text*Italique, <em>italic text</em>
Italique, tirets bas_italic text_Italique, identique au précédent
Gras et italique***bold and italic***<em><strong>bold and italic</strong></em>
Gras dans un motun**believ**ableSeul le milieu du mot est en gras
Tirets bas dans un motsnake_case_nameTexte ordinaire, sans italique
Barré (GFM)~~no longer true~~Texte barré, <del>no longer true</del>
Souligné<ins>underlined</ins>Texte souligné. Markdown n'a pas de syntaxe pour souligner, c'est donc du HTML
Surligné<mark>highlighted</mark>Texte surligné là où le site autorise la balise <mark>. Markdown n'a pas de syntaxe pour surligner

Sauts de ligne et paragraphes

Appuyer une seule fois sur Entrée dans un paragraphe ne crée pas de nouvelle ligne dans le rendu. Utilisez plutôt l'une de ces formes.

ÉlémentMarkdownRendu
Nouveau paragrapheFirst paragraph. Second paragraph.Deux paragraphes. Une ligne vide les sépare
Saut : deux espacesRoses are red, Violets are blue.Un paragraphe avec un <br> après red,. La première ligne se termine par deux espaces, invisibles
Saut : barre oblique inverseRoses are red,\ Violets are blue.Le même <br>, avec un repère visible. Fonctionne dans CommonMark et sur GitHub
Saut : HTMLRoses are red,<br>Violets are blue.Le même <br>. Fonctionne aussi dans une cellule de tableau
Retour à la ligne simpleRoses are red, Violets are blue.Une seule ligne : Roses are red, Violets are blue. Les issues et commentaires GitHub conservent le saut ; les fichiers .md non
Lignes vides en plusOne. Two.Identique à une seule ligne vide. Pour plus d'espace, mettez <br> seul sur une ligne

Listes

Indentez un élément imbriqué pour l'aligner sur le texte de l'élément du dessus : 2 espaces sous - , 3 espaces sous 1. .

ÉlémentMarkdownRendu
Liste à puces- Apples - Pears - PlumsUne liste à puces, <ul> avec trois <li>
Autres puces* Apples + Pears* et + créent aussi des puces. Changer de caractère commence une nouvelle liste
Liste numérotée1. Install 2. Configure 3. RunUne liste numérotée, <ol>
Numérotation paresseuse1. Install 1. Configure 1. RunToujours numérotée 1, 2, 3. Seul le premier numéro compte
Commencer à un numéro7. Seventh 8. Eighth<ol start="7">, numérotée à partir de 7
Liste imbriquée- Fruit - Apple - Pear - VegetablesUne liste dans le premier élément
Imbriquée, numérotée1. Download - Windows - macOS 2. InstallDes puces dans l'étape 1, indentées de 3 espaces
Paragraphe dans un élément- First item More about the first item. - Second itemDeux paragraphes dans le premier élément
Code dans un élément1. Run this: ```bash npm install ``` 2. Start the appUn bloc de code dans l'étape 1, indenté jusqu'au texte de l'élément

Listes de tâches (cases à cocher)

Une extension de GitHub Flavored Markdown : un élément de liste qui commence par [ ] ou [x] devient une case à cocher.

ÉlémentMarkdownRendu
Case vide- [ ] Write testsUne case non cochée
Case cochée- [x] Write testsUne case cochée. [X] fonctionne aussi
Liste de contrôle- [x] Draft - [ ] Review - [ ] PublishUne case cochée et deux vides. Dans les issues et pull requests GitHub, vous pouvez les cocher d'un clic
Tâches imbriquées- [ ] Release - [x] Tag the commit - [ ] Write the notesDeux sous-tâches sous la première case
Espace manquant- [] Write testsUne simple puce qui affiche [] Write tests. Les crochets doivent contenir un espace ou un x

Liens

Le texte du lien va entre crochets et l'adresse entre parenthèses juste après, sans espace entre les deux.

ÉlémentMarkdownRendu
Lien en ligne[Coddy](https://coddy.tech)<a href="https://coddy.tech">Coddy</a>
Lien avec un titre[Coddy](https://coddy.tech "Learn to code")Le même lien. Le titre s'affiche en info-bulle au survol
URL entre chevrons<https://coddy.tech>L'URL elle-même, sous forme de lien
URL nue (GFM)https://coddy.techUn lien sur GitHub et les autres sites GFM, qui transforment aussi les adresses www. en liens. Texte ordinaire en CommonMark strict
Lien e-mail<hello@example.com>Un lien mailto:
Lien par référenceRead the [docs][1]. [1]: https://example.com/docsdocs pointe vers l'URL. La ligne [1]: n'est pas affichée
Référence raccourcieSee [GitHub]. [GitHub]: https://github.comGitHub pointe vers l'URL
Lien relatif[Install guide](docs/install.md)Un lien vers un fichier situé par rapport à celui-ci. Sur GitHub, il ouvre le fichier dans le dépôt
Lien vers un titre[Jump to setup](#getting-started)Fait défiler jusqu'à ## Getting Started sur la même page
Identifiants de titre## Getting Started!Reçoit l'identifiant getting-started sur GitHub : minuscules, espaces remplacés par des traits d'union, ponctuation autre que - et _ supprimée
Titre dans un autre fichier[Requirements](docs/install.md#requirements)Ouvre le fichier à ce titre
Espaces dans l'URL[Report](my%20report.pdf)Écrivez chaque espace %20, ou mettez l'URL entre chevrons : [Report](<my report.pdf>)
Ouvrir dans un nouvel onglet<a href="https://coddy.tech" target="_blank">Coddy</a>Markdown n'a pas de syntaxe pour cela. Le HTML fonctionne là où le site conserve l'attribut target

Images

Une image est un lien précédé de !. Le texte entre crochets devient le texte alternatif, que les lecteurs d'écran lisent à voix haute.

ÉlémentMarkdownRendu
Image![A cat asleep on a sofa](cat.png)<img src="cat.png" alt="A cat asleep on a sofa">
Image avec un titre![Logo](logo.png "Coddy logo")La même image avec une info-bulle au survol
Image depuis une URL![Build status](https://example.com/badge.svg)Charge l'image depuis le web
Image avec lien[![Logo](logo.png)](https://coddy.tech)Une image qui ouvre le lien quand on clique dessus
Image par référence![Logo][logo] [logo]: images/logo.pngIdentique à une image en ligne, avec l'URL définie une seule fois plus bas
Taille de l'image<img src="logo.png" alt="Logo" width="200">L'image, large de 200 pixels. Le Markdown simple n'a pas de syntaxe de taille, c'est donc une balise HTML <img>
Image centrée<p align="center"> <img src="logo.png" alt="Logo" width="200"> </p>Une image centrée, comme dans de nombreux fichiers README sur GitHub

Code et blocs de code

Les accents graves marquent du code dans une ligne ; une clôture de trois accents graves marque un bloc. Rien n'est mis en forme à l'intérieur du code.

ÉlémentMarkdownRendu
Code en ligneRun `npm install` first.npm install en police à chasse fixe, sous forme de <code>
Accent grave dans du code``Use `git` here``Le code Use `git` here. Entourez-le de plus d'accents graves qu'il n'en contient
Bloc de code``` npm install npm run dev ```Un bloc, <pre><code>, avec les sauts de ligne conservés
Coloration syntaxique```python def greet(name): return f"Hello, {name}" ```Un bloc Python avec la syntaxe colorée. Noms courants : js, ts, python, bash, json, html, css, sql
Clôture en tildes~~~js console.log("hi"); ~~~Identique à une clôture en accents graves
Code indenté const total = 42;Un bloc de code créé par 4 espaces d'indentation, après une ligne vide
Bloc diff```diff - const x = 1; + const x = 2; ```Les lignes supprimées en rouge et les lignes ajoutées en vert sur GitHub
Clôture dans un bloc````markdown ```js let a = 1; ``` ````Un bloc qui affiche la clôture intérieure comme du texte. La clôture extérieure doit avoir plus d'accents graves que l'intérieure

Tableaux

Une extension de GitHub Flavored Markdown. La deuxième ligne, la ligne de séparation, transforme la première en en-tête. Elle doit avoir le même nombre de cellules que l'en-tête, sinon aucun tableau n'est créé.

ÉlémentMarkdownRendu
Tableau| Name | Role | | ----- | ------ | | Ada | Admin | | Linus | Editor |Un tableau avec une ligne d'en-tête et deux lignes
Alignement des colonnes| Left | Center | Right | | :--- | :----: | ----: | | a | b | c |Les deux-points fixent l'alignement : à gauche, centré, à droite
Sans barres extérieuresName | Role --- | --- Ada | AdminLe même tableau. Les barres verticales en début et en fin de ligne sont facultatives
Largeur des colonnes| a | b | |---|---| | 1 | 2 |Les largeurs dépendent du contenu. Le nombre de traits d'union ne compte pas, et les barres n'ont pas besoin d'être alignées
Mise en forme dans les cellules| Command | Does | | --- | --- | | `git status` | Shows **changed** files |Le code, le gras, les liens et les images fonctionnent tous dans les cellules
Barre verticale dans une cellule| Operator | Meaning | | --- | --- | | `a \| b` | a or b |La cellule affiche a | b. Échappez la barre en \|, même dans du code
Saut de ligne dans une cellule| Step | Notes | | --- | --- | | 1 | First line<br>Second line |Deux lignes dans une cellule. Un vrai retour à la ligne terminerait la rangée
Cellules fusionnées<td colspan="2">Both columns</td>Les tableaux Markdown ne peuvent pas fusionner de cellules. Écrivez le tableau en HTML avec colspan ou rowspan

Citations

Commencez chaque ligne par >. Une citation peut contenir n'importe quel autre élément Markdown.

ÉlémentMarkdownRendu
Citation> Simple is better than complex.Une citation en retrait, <blockquote>
Plusieurs paragraphes> First paragraph. > > Second paragraph.Une citation avec deux paragraphes. La ligne > seule les garde ensemble
Citation imbriquée> The reply >> The original messageUne citation dans une citation
Autres éléments à l'intérieur> #### Note > - Back up first > - Then upgradeUn titre et une liste dans la citation
Alerte (GitHub)> [!NOTE] > Requires Node 20 or later.Un encadré Note coloré sur GitHub. Les autres types sont [!TIP], [!IMPORTANT], [!WARNING] et [!CAUTION]

Lignes horizontales

Trois traits d'union, astérisques ou tirets bas ou plus, seuls sur une ligne, tracent une ligne en travers de la page.

ÉlémentMarkdownRendu
Ligne---Une ligne horizontale, <hr>
Autres formes*** ___Deux autres lignes
Ligne après du texteSome text ---Un paragraphe, puis une ligne. Gardez la ligne vide
Ligne vide manquanteSome text ---Un titre de niveau 2, pas une ligne : --- sous une ligne de texte la souligne

Notes de bas de page

Prises en charge sur GitHub, GitLab et de nombreux générateurs de sites statiques. CommonMark strict n'a pas de notes de bas de page.

ÉlémentMarkdownRendu
Note de bas de pageMarkdown dates from 2004.[^1] [^1]: John Gruber created it, with Aaron Swartz.Un 1 en exposant qui renvoie à la note, listée en bas de la page
Note nomméeSee the spec.[^spec] [^spec]: https://spec.commonmark.orgLes étiquettes peuvent être des mots, mais les notes restent numérotées 1, 2, 3 dans l'ordre d'utilisation
Où la définir[^1]: The text of the note.La définition peut se trouver n'importe où dans le fichier. Elle s'affiche toujours à la fin

Échapper des caractères

Une barre oblique inverse devant un signe de ponctuation affiche le caractère lui-même au lieu de le mettre en forme.

ÉlémentMarkdownRendu
Astérisques littéraux\*not italic\*Texte ordinaire avec les astérisques : *not italic*
Dièse littéral\# Not a headingUn paragraphe qui commence par #
Nombre suivi d'un point2024\. A good year.Un paragraphe, pas une liste qui commence à 2024
Crochets littéraux\[not a link\](page.md)Les crochets et parenthèses tels que tapés
Accent grave littéral\`Un accent grave
Barre oblique inverse littérale\\Une barre oblique inverse
Ce qui peut être échappé\ ` * _ {} [] () <> # + - . ! |Tout signe de ponctuation ASCII. Une barre oblique inverse devant une lettre ou un chiffre reste une barre oblique inverse
Entités HTML&copy; 2026 &amp; &lt;div&gt;© 2026 & <div>, sous forme de texte
Pas d'échappement dans le code`*stars*`Le code *stars* tel que tapé. Dans le code, une barre oblique inverse est un caractère ordinaire

HTML dans le Markdown

La plupart des moteurs de rendu laissent passer le HTML, donc une balise couvre ce pour quoi Markdown n'a pas de syntaxe. GitHub supprime le HTML dangereux comme <script>, <style>, <iframe> et les attributs style.

ÉlémentMarkdownRendu
Touches du clavierPress <kbd>Ctrl</kbd> + <kbd>C</kbd>Ctrl et C dessinés comme des touches
Indice et exposantH<sub>2</sub>O and x<sup>2</sup>H₂O et x²
Section repliable<details> <summary>Show the answer</summary> The answer is **42**. </details>Une section qui s'ouvre au clic. Les lignes vides permettent au Markdown qu'elle contient d'être rendu
Markdown dans un bloc HTML<div> **not bold** </div>**not bold** tel que tapé. Le Markdown n'est pas lu dans un bloc HTML tant qu'une ligne vide ne termine pas le bloc
Texte coloré<span style="color: red">red</span>Du texte rouge sur les sites qui autorisent les styles en ligne. GitHub supprime l'attribut style

Commentaires

Markdown n'a pas de syntaxe de commentaire. Deux astuces gardent du texte hors de la page rendue.

ÉlémentMarkdownRendu
Commentaire masqué[//]: # (This line is never shown)Rien. La ligne est une définition de lien qu'aucun lien n'utilise, elle n'arrive donc jamais dans le HTML
Autre forme[comment]: <> (Also hidden)Rien, par la même astuce
Commentaire HTML<!-- TODO: add screenshots -->Rien sur la page, mais le commentaire reste dans le code source HTML
Commentaire sur plusieurs lignes<!-- This whole block is hidden -->Rien sur la page
EmplacementSome text. [//]: # (comment) More text.Deux paragraphes. La ligne de commentaire doit être précédée d'une ligne vide, sinon elle s'affiche comme du texte

GitHub Flavored Markdown et extras de GitHub

GitHub Flavored Markdown (GFM), c'est CommonMark plus les tableaux, les listes de tâches, le texte barré et les URL transformées en liens. GitHub ajoute encore d'autres fonctions.

FonctionMarkdownOù cela fonctionne
Tableaux| a | b | | --- | --- | | 1 | 2 |GFM : GitHub, GitLab et la plupart des outils de documentation
Listes de tâches- [x] DoneGFM
Texte barré~~text~~GFM
URL nues en lienswww.coddy.techGFM
Code avec un langage```js let a = 1; ```CommonMark et GFM. Les couleurs dépendent du site
Notes de bas de pageText.[^1] [^1]: Note.GitHub et GitLab, bien qu'elles ne soient pas dans la spécification GFM
Emoji:rocket: :tada:GitHub et GitLab transforment les codes courts en emoji
Mentions@octocatGitHub : crée un lien vers l'utilisateur et le notifie
Liens vers des issues#123GitHub : crée un lien vers l'issue ou la pull request 123 du même dépôt
Diagrammes```mermaid graph LR A --> B ```GitHub et GitLab dessinent un diagramme Mermaid
Mathématiques$E = mc^2$ $$ \sum_{i=1}^{n} i $$GitHub affiche les formules LaTeX, en ligne entre des signes $ et en bloc entre des lignes $$

Toute la syntaxe Markdown sur une seule page, à côté de ce qu'elle produit. Cet aide-mémoire Markdown couvre la syntaxe de base (titres, mise en valeur, sauts de ligne, listes, liens, images, code, citations) et les extensions de GitHub Flavored Markdown : tableaux avec alignement, listes de tâches, texte barré, URL transformées en liens et notes de bas de page, ainsi que l'échappement, le HTML et les commentaires.

Les exemples suivent CommonMark et GitHub Flavored Markdown, les règles sur lesquelles reposent GitHub, GitLab et la plupart des outils de documentation. Quand un site se comporte autrement, la ligne le précise. Pour voir un exemple s'afficher pendant que vous tapez, collez-le dans l'éditeur Markdown.

FAQ de l'aide-mémoire Markdown

Comment créer un tableau en Markdown ?
Écrivez la ligne d'en-tête avec les cellules entre des barres verticales, puis une ligne de séparation faite de traits d'union, puis une ligne par rangée : | Name | Role |, | --- | --- |, | Ada | Admin |. Des deux-points dans la ligne de séparation alignent une colonne : :--- à gauche, :---: au centre, ---: à droite. Les tableaux font partie de GitHub Flavored Markdown : ils fonctionnent donc sur GitHub, GitLab et la plupart des outils de documentation, mais pas en CommonMark strict.
Comment aller à la ligne en Markdown ?
Un simple retour à la ligne dans un paragraphe est ignoré dans le rendu. Pour forcer un saut de ligne, terminez la ligne par deux espaces ou une barre oblique inverse (\), ou écrivez <br>. Pour commencer un nouveau paragraphe, laissez une ligne vide. Les issues et commentaires GitHub font exception : un simple retour à la ligne y apparaît déjà comme un saut de ligne.
Comment écrire un commentaire en Markdown ?
Markdown n'a pas de syntaxe de commentaire, mais deux astuces fonctionnent. [//]: # (your comment) seul sur une ligne, précédé d'une ligne vide, est une définition de lien que rien n'utilise : il n'arrive donc jamais ni sur la page ni dans le HTML. Un commentaire HTML, <!-- your comment -->, est lui aussi masqué sur la page mais reste dans le code source HTML, où quiconque affiche la source peut le lire.
Comment créer un bloc de code en Markdown ?
Placez trois accents graves sur la ligne qui précède le code et trois sur la ligne qui le suit. Ajoutez un nom de langage après les accents graves d'ouverture, comme ```python, pour obtenir la coloration syntaxique. Pour du code au milieu d'une phrase, entourez-le d'un seul accent grave de chaque côté : `npm install`.
Comment ajouter une case à cocher en Markdown ?
Commencez un élément de liste par [ ] pour une case vide ou [x] pour une case cochée : - [ ] Review ou - [x] Draft. Gardez l'espace à l'intérieur des crochets vides. Les cases à cocher font partie de GitHub Flavored Markdown, et dans les issues et pull requests GitHub, vous pouvez les cocher d'un clic.
Comment changer la taille d'une image en Markdown ?
Le Markdown simple n'a pas de syntaxe de taille : ![alt text](image.png) affiche toujours l'image à sa taille d'origine. Utilisez plutôt une balise HTML, comme <img src="image.png" alt="alt text" width="300">, que GitHub et la plupart des moteurs de rendu acceptent. Indiquez seulement la largeur ou seulement la hauteur pour conserver les proportions.
Comment faire un lien vers un titre en Markdown ?
Faites un lien vers l'identifiant du titre avec # : [Setup](#getting-started) mène à ## Getting Started. GitHub construit l'identifiant à partir du texte du titre en minuscules, avec les espaces remplacés par des traits d'union et la ponctuation supprimée, sauf les traits d'union et les tirets bas. Pour un titre dans un autre fichier, placez l'identifiant après le nom du fichier : [Setup](docs/install.md#getting-started).
Qu'est-ce qu'un fichier .md ?
Un fichier texte brut écrit en Markdown. .md et .markdown sont les extensions habituelles, et README.md est le fichier que GitHub affiche sur la page d'accueil d'un dépôt. N'importe quel éditeur de texte peut l'ouvrir ; GitHub, les sites de documentation et les visionneuses Markdown l'affichent sous forme de texte mis en forme. Pour voir un fichier rendu pendant que vous le modifiez, collez-le dans l'éditeur Markdown.
Coddy programming languages illustration

Apprenez Markdown avec Coddy

COMMENCER