Référence de syntaxe

La syntaxe Markdown : les motifs que vous utiliserez le plus

Vous pouvez écrire du Markdown utile avec un petit ensemble de motifs. Commencez par une structure sémantique, laissez des lignes vides autour des éléments de bloc et prévisualisez le document dans le moteur de rendu où il sera publié.

8 minutes de lecture

Titres et paragraphes

Préfixez un titre avec un à six caractères dièse. Utilisez un seul H1 pour le titre du document, puis descendez dans les niveaux sans choisir les titres uniquement pour leur taille visuelle. Les paragraphes sont séparés par une ligne vide.

TitresMarkdown
# Document title

An opening paragraph.

## Installation

Setup details.

### Environment variables

Configuration details.

Emphase, liens et images

Utilisez des astérisques pour l'emphase, des crochets pour le texte visible du lien et des parenthèses pour la destination. La syntaxe des images ajoute un point d'exclamation ; un texte alternatif pertinent reste important lorsque l'image ne peut pas être vue.

Syntaxe en ligneMarkdown
Use **bold** for strong importance and *italic* for emphasis.

Read the [deployment guide](/guides/deploy).

![A diagram of the request flow](request-flow.png)

Listes et listes de tâches

Commencez les éléments non ordonnés par un trait d'union et les éléments ordonnés par un numéro. Indentez les éléments imbriqués de manière cohérente. De nombreuses plateformes de développement prennent également en charge les cases à cocher des listes de tâches via GitHub Flavored Markdown.

ListesMarkdown
- Prepare the release
  - Update the changelog
  - Freeze migrations
- Deploy

1. Start the canary
2. Watch metrics
3. Expand traffic

- [x] Tests pass
- [ ] Docs reviewed

Code en ligne et blocs de code délimités

Enveloppez les identifiants ou commandes courts dans des accents graves simples. Placez les exemples plus longs entre des délimiteurs à triple accent grave et ajoutez un nom de langage lorsque le moteur de rendu prend en charge la coloration syntaxique. Gardez les exemples exécutables suffisamment complets pour être compris et testés.

CodeMarkdown
Set `SERVICE_URL` in the server environment.

```ts
type Result = {
  markdown: string;
  fileName: string;
};
```

Citations, règles horizontales et tableaux

Les citations sont utiles pour du matériel cité ou de courts encarts. Les règles horizontales séparent les grandes transitions. Les tableaux conviennent aux données compactes et rectangulaires ; ils deviennent difficiles à lire lorsque les cellules contiennent de longs paragraphes ou lorsque le tableau est très large.

Tableau GFMMarkdown
> Conversion preserves structure, not pixel-perfect layout.

---

| Format | Good for | Review |
| --- | --- | --- |
| DOCX | Styled prose | Tables |
| CSV | Small datasets | Escaping |

Écrivez une syntaxe qui survit aux différents moteurs de rendu

Laissez des lignes vides autour des titres, des listes, des tableaux et des blocs de code délimités. Préférez des liens descriptifs aux URL nues. Évitez le HTML brut, sauf si le système de publication le prend explicitement en charge et l'assainit. Lorsqu'une fonctionnalité est propre à une plateforme, incluez suffisamment de texte brut pour que le document reste compréhensible ailleurs.

Un aperçu vous indique comment le document est rendu ici ; votre dépôt cible ou votre système de documentation reste le test de compatibilité final.

Pratiquez la syntaxe avec un aperçu en direct

Ouvrez un brouillon local et voyez les titres, les listes, le code et les tableaux se mettre en forme pendant que vous tapez.

Essayer l'éditeur