Éditeur Markdown

Écrivez en Markdown, prévisualisez instantanément. Support GFM complet.

Markdown
Prévisualisation

Guide complet du Markdown

Pourquoi Markdown

Après des années à rédiger de la documentation technique, Markdown est devenu mon format d'écriture par défaut. Inventé par John Gruber en 2004, c'est un langage de balisage léger qui convertit du texte brut en HTML. Sa force : la lisibilité du source même sans rendu. README sur GitHub, documentation, notes, blogs : Markdown est partout.

Syntaxe de base

Formatage texte

**gras**, *italique*, ~~barré~~, `code`. Combinables : ***gras italique***.

Titres

# Titre 1, ## Titre 2, jusqu'à ###### Titre 6. L'espace après le # est important.

Listes

- ou * pour les puces, 1. 2. 3. pour les numérotées. Indenter pour imbriquer.

Liens & Images

[texte](url) pour les liens, ![alt](url) pour les images.

Syntaxe avancée (GitHub Flavored Markdown)

  • Blocs de code : Triple backticks avec le langage : ```javascript
  • Tableaux : Barres verticales | pour les colonnes, tirets --- pour l'en-tête
  • Cases à cocher : [ ] non cochée, [x] cochée (listes de tâches)
  • Références : [texte][ref] puis [ref]: url "titre"
  • Notes de bas de page : [^1] puis [^1]: Explication
  • Emoji : :smile: :rocket: (support GitHub)

Bonnes pratiques

  • Une ligne vide entre les paragraphes
  • Utiliser les titres hiérarchiquement (pas de H3 sans H2)
  • Préférer les listes pour la clarté
  • Ajouter un alt text aux images pour l'accessibilité
  • Utiliser des liens relatifs dans les repos Git

Questions fréquentes

Quelle différence entre Markdown et GFM ?

GFM (GitHub Flavored Markdown) est une extension du Markdown standard. Il ajoute : tableaux, blocs de code avec syntaxe highlighting, cases à cocher, barré (~~texte~~), liens automatiques, et mentions (@user). La plupart des plateformes modernes supportent GFM. Notre éditeur l'utilise par défaut.

Comment faire un saut de ligne sans nouveau paragraphe ?

Terminez la ligne par deux espaces puis Entrée, ou utilisez la balise HTML <br>. Un simple Entrée ne crée pas de saut de ligne visible : c'est une source fréquente de confusion. Une ligne vide crée un nouveau paragraphe (plus d'espacement).

Comment échapper les caractères Markdown ?

Utilisez le backslash : \* pour un astérisque littéral, \# pour un dièse, etc. Les caractères à échapper si besoin : \ ` * _ { } [ ] ( ) # + - . ! |. Dans les blocs de code (backticks), pas besoin d'échapper.

Peut-on utiliser du HTML dans Markdown ?

Oui, le HTML inline est généralement supporté. Utile pour des éléments que Markdown ne gère pas : <details> pour les accordéons, <kbd> pour les touches clavier, <sup> pour les exposants. Certaines plateformes (GitHub issues) filtrent le HTML par sécurité.

Comment créer une table des matières automatique ?

Le Markdown standard ne le supporte pas, mais certaines plateformes ont des extensions. Sur GitHub, [TOC] ne fonctionne pas mais vous pouvez créer des liens vers les titres manuellement : [Section](#section). GitLab supporte [[_TOC_]]. Pour les générateurs statiques (Jekyll, Hugo), utilisez leurs plugins dédiés.

Markdown ou reStructuredText pour la documentation ?

Markdown pour la simplicité et la popularité (README, blogs, notes). reStructuredText pour la documentation Python (Sphinx) ou des besoins avancés (références croisées natives, directives extensibles). Pour la documentation technique complexe, considérez aussi AsciiDoc. Pour les projets GitHub, Markdown est le standard de facto.