Guide de syntaxe Markdown : Des bases aux fonctionnalités avancées

Markdown est le format d'écriture que les développeurs apprécient réellement. Pas besoin de cliquer dans des menus de formatage, pas de lutte avec des éditeurs WYSIWYG — juste du texte brut avec quelques symboles qui se convertit en HTML propre. Les fichiers README, la documentation, les articles de blog, les messages de chat et même cet article sont écrits en Markdown.

Prévisualisez votre Markdown en temps réel avec notre Prévisualiseur Markdown — écrivez d'un côté, voyez le résultat formaté de l'autre.

Syntaxe de base

Titres

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

Utilisez les titres de manière hiérarchique. Ne sautez pas de niveaux (passer de H1 à H3) — cela nuit à la fois à la lisibilité et à l'accessibilité.

Mise en forme

*italic* or _italic_
**bold** or __bold__
***bold italic***
~~strikethrough~~

Liens et images

[Link text](https://example.com)
[Link with title](https://example.com "Title")
![Alt text](image.png)

Listes

- Unordered item
- Another item
  - Nested item

1. First item
2. Second item
3. Third item

Citations

> This is a blockquote.
> It can span multiple lines.

Code

Code en ligne

Utilisez des accents graves pour le code en ligne : `const x = 42`

Blocs de code

Triple accents graves avec un identifiant de langage optionnel :

```javascript
function greet(name) {
  return `Hello, ${name}!`;
}
```

Les langages supportés incluent javascript, python, json, yaml, html, css, bash et bien d'autres.

Tableaux

| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Cell 1   | Cell 2   | Cell 3   |
| Cell 4   | Cell 5   | Cell 6   |

Alignement :

| Left | Center | Right |
|:-----|:------:|------:|
| L    |   C    |     R |

Syntaxe avancée

Listes de tâches

- [x] Completed task
- [ ] Pending task
- [ ] Another task

Notes de bas de page

Here is a statement[^1].

[^1]: This is the footnote content.

Listes de définitions

Term
: Definition of the term

Règles horizontales

---
***
___

GitHub Flavored Markdown (GFM)

GitHub étend le Markdown standard avec des fonctionnalités utiles :

• URLs auto-liées — Les URLs brutes deviennent cliquables
• Listes de tâches — Cases à cocher dans les issues et PR
• Tableaux — La syntaxe avec pipes montrée ci-dessus
• Texte barré — ~~deleted text~~
• Coloration syntaxique — Coloration de code spécifique au langage
• Emoji — :smile: devient un smiley

Conseils de rédaction

• Gardez les paragraphes courts — 3 à 5 phrases maximum
• Utilisez les titres pour créer une structure facile à parcourir
• Préférez les listes aux longs paragraphes pour les étapes ou les fonctionnalités
• Ajoutez des exemples de code chaque fois que vous discutez de concepts techniques
• Prévisualisez régulièrement — notre Prévisualiseur Markdown affiche le résultat au fur et à mesure de la saisie

Questions fréquemment posées

Quelle est la différence entre Markdown et HTML ?

Markdown est un format d'écriture simplifié qui se convertit en HTML. Il couvre les besoins de formatage les plus courants avec beaucoup moins de syntaxe. Vous pouvez intégrer du HTML brut dans Markdown lorsque vous avez besoin de fonctionnalités que Markdown ne prend pas en charge.

Quelle variante de Markdown dois-je utiliser ?

GitHub Flavored Markdown (GFM) est la plus largement supportée. Elle ajoute les tableaux, les listes de tâches et le texte barré au Markdown standard. CommonMark est la spécification standardisée.

Puis-je utiliser Markdown pour la documentation ?

Absolument. Markdown est le standard pour les fichiers README, les wikis et les sites de documentation. Des outils comme MkDocs, Docusaurus et GitBook utilisent tous Markdown.

Ressources connexes

• Markdown vs Rich Text — pourquoi les développeurs préfèrent le texte brut
• Outil de comparaison de texte — comparez des fichiers Markdown
• Prévisualiseur Markdown — prévisualisez Markdown en temps réel
• Outil de comparaison de texte — comparez des fichiers texte et Markdown