Aide-mémoire Markdown — la syntaxe avec aperçu en direct

De un à six # suivis d’une espace. Utilisez un seul titre # par document et ne sautez pas de niveau : les lecteurs d’écran et les tables des matières s’appuient sur cet ordre.

# Heading 1
## Heading 2
### Heading 3
#### Heading 4

L’ancien style « setext », limité aux niveaux 1 et 2. Une ligne de --- sous un paragraphe en fait un titre, ce qui surprend quand on attend une ligne horizontale : laissez une ligne vide avant ---.

Heading 1
=========

Heading 2
---------

Une ligne vide sépare les paragraphes. Un simple retour à la ligne à l’intérieur d’un paragraphe est fusionné en une seule ligne (sauf exceptions indiquées dans « Sauts de ligne »).

First paragraph, which can wrap
across several source lines.

Second paragraph after a blank line.

Pour aller à la ligne sans créer de paragraphe, terminez la ligne par deux espaces ou une barre oblique inverse. Les commentaires GitHub, Obsidian (par défaut), Slack et Discord traitent au contraire chaque retour à la ligne comme un saut.

Two trailing spaces  
make a break.
A trailing backslash\
works too.<br>So does an HTML br.

Les astérisques fonctionnent à l’intérieur des mots, pas les tirets bas (les noms_en_snake_case restent tels quels) : c’est pourquoi la plupart des guides de style recommandent *.

**bold** or __bold__

*italic* or _italic_

***bold italic***

in**side**word works with *, not with _

Commencez chaque ligne par >. Une citation peut contenir n’importe quel autre élément Markdown, y compris des listes et du code.

> Quoted text.
> Still quoted.
>
> > Nested quote.

-, * et + fonctionnent tous ; ne les mélangez pas dans une même liste (un autre marqueur commence une nouvelle liste).

- Item
- Item
  - Nested (indent 2 spaces)
- Item

Le premier numéro fixe le point de départ ; les suivants sont ignorés : mettre « 1. » sur chaque ligne permet donc une renumérotation automatique quand vous réordonnez les éléments.

1. First
1. Second
1. Third

3. Starts at three
4. Four

Indentez le contenu supplémentaire pour l’aligner sur le premier caractère du texte de l’élément (3 espaces après « 1. »).

1. Install:

   ```sh
   npm install marked
   ```

2. Indent continuation lines
   to the item text.

Le Markdown placé entre accents graves n’est pas interprété.

Run `npm test` now.

Use ``double `backticks` `` when the code contains one.

Trois accents graves (ou ~~~) sur des lignes à part. Le mot qui suit la clôture indique le langage pour la coloration syntaxique sur GitHub, GitLab, Obsidian et Discord.

```js
const answer = 42;
console.log(answer);
```

const answer = 42;
console.log(answer);

La syntaxe d’origine. Les clôtures sont plus lisibles et permettent d’indiquer un langage ; le code indenté est la seule forme que comprend l’ancien Reddit.

Paragraph.

    four spaces of indent
    make a code block

four spaces of indent
make a code block

Au moins trois -, * ou _ seuls sur une ligne, précédés d’une ligne vide.

Above

---

Below (also *** or ___)

La forme entre chevrons est le lien automatique de CommonMark. Les espaces d’une URL doivent être écrites %20, ou l’URL placée entre <…>.

[Link text](https://freetoolsforweb.com)

[With a title](https://freetoolsforweb.com "Hover text")

[Relative link](/tools/regex-cheat-sheet)

<https://example.com>

Évite d’encombrer le texte avec de longues URL. Les définitions peuvent se trouver n’importe où dans le document et ne sont pas affichées.

Read the [spec][cm] and the [GFM spec].

[cm]: https://spec.commonmark.org/
[GFM spec]: https://github.github.com/gfm/

Sur GitHub et GitLab, chaque titre reçoit un identifiant automatique : en minuscules, espaces remplacées par des traits d’union, ponctuation supprimée (« ## Install & Run » devient #install--run). Obsidian utilise plutôt [[#Titre]].

[Jump to tables](#md-tables)

Comme un lien, précédé de !. Le texte entre [ ] est le texte alternatif : décrivez l’image pour les personnes qui ne la voient pas. Markdown n’a pas de syntaxe de taille ; utilisez le HTML <img width="200"> là où il est autorisé.

![Site logo](/brand/favicon.svg "Optional title")

[![Clickable image](/brand/favicon.svg)](/tools)

Une barre oblique inverse rend littéral n’importe quel signe de ponctuation ASCII : \ ` * _ { } [ ] ( ) # + - . ! |

\*not italic\*  \# not a heading  1\. not a list

Autorisé par CommonMark. GitHub et GitLab en conservent un sous-ensemble sûr (pas de script, de style ni de gestionnaires d’événements) ; Slack, Discord, Reddit et Notion l’affichent comme du texte.

Press <kbd>Ctrl</kbd> + <kbd>C</kbd>, H<sub>2</sub>O, x<sup>2</sup>.

Un commentaire HTML est conservé dans la source mais n’est pas affiché, partout où le HTML est autorisé.

Visible.

<!-- Not rendered: notes for editors -->

Also visible.

La deuxième ligne est obligatoire ; les deux-points fixent l’alignement. Les colonnes n’ont pas besoin d’être alignées dans la source. Échappez une barre verticale littérale avec \|. Pas de cellules fusionnées ni de cellules sur plusieurs lignes (utilisez <br> dans une cellule sur GitHub).

Où : GFM, GitLab, Obsidian, Reddit ; Notion au collage

| Left | Centre | Right |
| :--- | :----: | ----: |
| a    |   b    |     1 |
| `c`  | **d**  |    22 |

Sur GitHub et GitLab, les cases sont cliquables dans les tickets et les pull requests, et mettent à jour la source.

Où : GFM, GitLab, Obsidian ; Notion via le raccourci []

- [x] Write the draft
- [ ] Review
- [ ] Publish

Deux tildes partout ; GitHub en accepte aussi un seul. Slack utilise un ~seul~ tilde, Jira des -traits d’union-.

Où : GFM, GitLab, Obsidian, Discord, Reddit, Notion

~~no longer true~~

GFM transforme en liens les URL nues et les adresses en www. En CommonMark pur, elles restent du texte sauf si elles sont placées entre <…>.

Où : GFM, GitLab, Obsidian, Slack, Discord, Reddit

Visit https://freetoolsforweb.com or www.example.com.

La définition peut être placée n’importe où ; les notes sont numérotées dans l’ordre des renvois et listées à la fin. Obsidian propose aussi des notes en ligne : ^[comme ceci].

Où : GFM, GitLab, Obsidian (pas CommonMark)

Markdown was created in 2004.[^1]

[^1]: By John Gruber, with Aaron Swartz.

Vous définissez l’ancre vous-même. Pris en charge par Pandoc, PHP Markdown Extra, Hugo, Jekyll (kramdown), MkDocs et Docusaurus ; GitHub et GitLab l’ignorent, affichent les accolades et utilisent des identifiants automatiques.

Où : Pandoc, Hugo, Jekyll, MkDocs, Docusaurus ; pas GitHub ni GitLab

### Install {#setup}

Des noms entourés de deux-points. Taper deux-points dans GitHub, Slack, Discord ou Notion ouvre un sélecteur d’emoji. Coller l’emoji lui-même fonctionne partout.

Où : GitHub, GitLab, Slack, Discord ; pas Obsidian (sans plugin) ni CommonMark

Ship it :rocket: :+1: :tada:

Du TeX entre signes $ en ligne, $$ pour un bloc centré. GitHub accepte aussi $`…`$ et un bloc ```math ; GitLab prend en charge les mêmes formes. Notion utilise $$…$$ pour les équations en ligne.

Où : GitHub, GitLab, Obsidian, Notion (syntaxe propre)

Inline: $E = mc^2$

$$
\sum_{i=1}^{n} i = \frac{n(n+1)}{2}
$$

Un bloc de code avec le langage mermaid devient un diagramme : organigrammes, diagrammes de séquence, de classes, d’états, de Gantt et entité-association.

Où : GitHub, GitLab, Obsidian, Notion (bloc de code Mermaid)

```mermaid
flowchart LR
  A[Write] --> B{Review}
  B -->|ok| C[Publish]
  B -->|changes| A
```

GitHub propose cinq types : NOTE, TIP, IMPORTANT, WARNING, CAUTION. GitLab (17.10+) accepte la même syntaxe. Obsidian offre bien plus de types, des titres personnalisés (> [!tip] Titre) et le repli (> [!faq]-).

Où : GitHub, GitLab 17.10+, Obsidian ; simple citation ailleurs

> [!NOTE]
> Useful information.

> [!WARNING]
> Critical content that needs attention.

Du HTML, mais largement pris en charge. Laissez des lignes vides autour du Markdown à l’intérieur, sinon il n’est pas interprété.

Où : GitHub, GitLab, Obsidian, la plupart des générateurs de sites statiques

<details>
<summary>Click to expand</summary>

Hidden **Markdown** content.

</details>

Obsidian et certains éditeurs (Typora, iA Writer) ; GitHub affiche les signes égal. Utilisez <mark> là où le HTML est autorisé.

Où : Obsidian, Typora ; pas GitHub

This is ==highlighted== text.