L'Ultime Aide-mémoire Markdown : Syntaxe, Aperçu et Meilleures Pratiques

Markdown est un langage de balisage léger doté d'une syntaxe de formatage en texte brut. Il est largement utilisé pour les fichiers README, la documentation et les articles de blog. Parce qu'il est facile à lire et à écrire, Markdown est devenu la norme pour la communication entre développeurs.

Utilisez cet aide-mémoire comme référence rapide pour la syntaxe Markdown standard et la syntaxe GitHub Flavored Markdown (GFM).

---

1. Formatage du texte

Style de base pour votre texte.

Élément	Syntaxe	Résultat
Titres	# H1 à ###### H6	H1 à H6
Gras	**texte** ou __texte__	texte
Italique	*texte* ou _texte_	texte
Barré	~~texte~~	texte
Citation	> quote	> quote
Règle horizontale	--- ou ***

---

2. Listes

Organisez votre contenu avec des listes ordonnées, non ordonnées ou des listes de tâches.

• Liste non ordonnée : Utilisez *, - ou +.

  - Élément 1
  - Élément 2
    - Sous-élément
  

• Liste ordonnée : Utilisez des chiffres suivis d'un point.

  1. Premier élément
  2. Deuxième élément
  

• Liste de tâches (GFM) :

  - [x] Tâche terminée
  - [ ] Tâche incomplète
  

---

3. Liens et images

• Lien : [Texte](URL) -> Google
• Image : ![Texte alternatif](URL)
• Lien avec titre : [Texte](URL "Titre")

---

4. Blocs de code

• Code en ligne : Utilisez des accents graves simples : `code`.
• Bloc de code : Utilisez des accents graves triples avec mise en évidence optionnelle de la langue :

  ```javascript
  console.log("Bonjour le monde !");
  

---

5. Tableaux et syntaxe avancée

Tableaux :

| En-tête 1 | En-tête 2 |
| :--- | :--- |
| Cellule 1 | Cellule 2 |
| Cellule 3 | Cellule 4 |

Notes de bas de page :

Voici une référence de note de bas de page[^1].
[^1] : Voici le contenu de la note de bas de page.

---

6. Variantes de Markdown (Flavors)

• CommonMark : La version standard et hautement compatible de Markdown.
• GitHub Flavored Markdown (GFM) : Ajoute la prise en charge des tableaux, des listes de tâches, du texte barré et des liens automatiques. La plupart des moteurs de rendu modernes prennent en charge le GFM.
• HTML dans Markdown : Vous pouvez utiliser des balises HTML brutes (comme <u> ou <div>) à l'intérieur de Markdown pour des mises en page plus complexes, bien que certains moteurs de rendu puissent les supprimer pour des raisons de sécurité.

---

Questions courantes (FAQ)

Q : Comment puis-je prévisualiser mon Markdown ?

R : La plupart des éditeurs de code comme VS Code disposent d'un aperçu Markdown intégré (Ctrl+Maj+V). Vous pouvez également utiliser des moteurs de rendu Markdown en ligne ou des éditeurs spécialisés pour voir à quoi ressemblera votre document après avoir été converti en HTML.

Q : Quelle est la différence entre un éditeur Markdown et un moteur de rendu ?

R : Un éditeur est l'endroit où vous écrivez la syntaxe en texte brut. Un moteur de rendu (ou parseur) est le moteur qui convertit cette syntaxe en HTML pour l'affichage dans un navigateur.

Q : Quelles sont les meilleures pratiques pour écrire en Markdown ?

R :

1. Cohérence : Tenez-vous-en à un seul style pour les listes (- vs *) et les titres.
2. Lisibilité : Utilisez des lignes vides entre les paragraphes et les éléments de liste.
3. Texte alternatif : Fournissez toujours un texte alternatif significatif pour les images afin de garantir l'accessibilité.
4. Blocs de code : Spécifiez toujours la langue pour les blocs de code afin d'activer la mise en évidence de la syntaxe.

---

Sur Tool3M

• Markdown vers HTML : Convertissez et prévisualisez instantanément votre Markdown en un HTML propre et prêt pour la production.
• Formateur SQL : Formatez des blocs de code SQL pour les coller dans votre documentation Markdown.