Passer au contenu principal

Aide-mémoire & Guide de syntaxe Markdown

Copiez des exemples concrets pour la syntaxe dont vous avez besoin, visualisez le rendu et adaptez-les pour votre documentation ou vos fichiers README.

Titres

Ajoutez 1 à 6 symboles # avant une ligne. Plus de symboles créent un titre de niveau inférieur.

Syntaxe vs Aperçu
Syntaxe copiable
# Heading Level 1
## Heading Level 2
### Heading Level 3
#### Heading Level 4
##### Heading Level 5
###### Heading Level 6
Aperçu rendu

Heading Level 1

Heading Level 2

Heading Level 3

Heading Level 4

Heading Level 5
Heading Level 6

Gras, italique et barré

Entourez le texte d’astérisques, de tirets bas ou de tildes pour ajouter de l’emphase ou indiquer du texte supprimé.

Syntaxe vs Aperçu
Syntaxe copiable
This text is *italicized*.
This text is _italicized_ as well.

This text is **bolded**.
This text is __bolded__ as well.

This text is ***bold and italicized***.

This text is ~~strikethrough~~.
Aperçu rendu

This text is italicized.

This text is italicized as well.

This text is bolded.

This text is bolded as well.

This text is bold and italicized.

This text is strikethrough.

Listes ordonnées, à puces et de tâches

Utilisez des chiffres pour les étapes numérotées, des tirets pour les puces et des crochets avec un x pour les tâches.

Syntaxe vs Aperçu
Syntaxe copiable
- Unordered list item 1
- Unordered list item 2
  - Indented nested item

1. Ordered list item 1
2. Ordered list item 2

- [x] Completed task item
- [ ] Incomplete task item
Aperçu rendu
  • Unordered list item 1
  • Unordered list item 2
    • Indented nested item
  1. Ordered list item 1
  2. Ordered list item 2
  • Completed task item
  • Incomplete task item

Code en ligne et blocs de code balisés

Utilisez des accents graves simples pour le code en ligne et triples avec balise de langage pour les blocs.

Syntaxe vs Aperçu
Syntaxe copiable
Use inline `const value = true` variables.

Fenced code block:
```javascript
const greeting = "Hello, developer!";
console.log(greeting);
```
Aperçu rendu

Use inline const value = true variables.

javascript
const greeting = "Hello, developer!";
console.log(greeting);

Tableaux et alignement des colonnes

Utilisez des barres verticales pour séparer les colonnes et des tirets avec deux-points sur la 2e ligne pour l’alignement.

Syntaxe vs Aperçu
Syntaxe copiable
| Parameter | Type | Default |
| :--- | :---: | ---: |
| format | string | "MD" |
| local | boolean | true |
| threads | number | 4 |
Aperçu rendu
Parameter Type Default
format string "MD"
local boolean true
threads number 4

Citations en bloc et imbriquées

Commencez les lignes par un chevron ouvrant (>) pour citer du texte ou mettre en évidence des avertissements.

Syntaxe vs Aperçu
Syntaxe copiable
> This is a blockquote element.
>
> > This is nested inside the parent quote.
Aperçu rendu

This is a blockquote element.

This is nested inside the parent quote.

Lignes horizontales, notes de bas de page et HTML

Utilisez trois tirets pour les séparateurs, des crochets avec accent circonflexe pour les notes ou des balises HTML.

Syntaxe vs Aperçu
Syntaxe copiable
Create dividers with asterisks:
***

Escape characters with backslash:
\* Literal asterisk (not bullet)

Embed keyboard labels:
<kbd>Cmd</kbd> + <kbd>Option</kbd>
Aperçu rendu

Create dividers with asterisks:


Escape characters with backslash:
* Literal asterisk (not bullet)

Embed keyboard labels:
Cmd + Option

Foire aux questions

Qu’est-ce que Markdown ?

Markdown est un langage de balisage léger qui permet de formater du texte brut à l’aide de symboles simples et lisibles.

Le GitHub-flavored Markdown (GFM) est-il pris en charge ?

Oui. Cette référence et l’éditeur intégré prennent en charge les listes de tâches, tableaux, texte barré et blocs de code avec coloration syntaxique.

Comment ajouter un saut de ligne en Markdown ?

Terminez une ligne par deux espaces avant d’appuyer sur Entrée, ou laissez une ligne vide pour démarrer un nouveau paragraphe.

Puis-je écrire du HTML brut dans Markdown ?

Oui. La plupart des moteurs de rendu Markdown autorisent les balises HTML standard pour les mises en page spécifiques.