Essayer Markdown

Aide-mémoire

Qu'est-ce qu'un aide-mémoire Markdown ?

Markdown est un format texte brut pour les documents structurés. Un aide-mémoire est une référence rapide pour la syntaxe : titres, listes, liens, tableaux, blocs de code, etc. La spécification CommonMark et GitHub Flavored Markdown (GFM) définissent la syntaxe utilisée dans les README, docs et wikis.

Cet outil affiche un aide-mémoire prêt à copier dans le panneau droit. Utilisez l'éditeur de gauche pour tester la syntaxe. Copiez ou téléchargez l'aide-mémoire pour une utilisation hors ligne. Pour générer des tableaux depuis CSV, utilisez le Générateur de tableaux Markdown.

Comment utiliser cet outil

1

Consulter l'aide-mémoire

Le panneau droit affiche les titres, l'emphase, les listes, les liens, les images, les citations, le code, les tableaux, les listes de tâches et les règles horizontales. Chaque exemple utilise la syntaxe CommonMark et GFM standard.

2

Essayer Markdown dans l'éditeur

Collez ou tapez du Markdown dans l'éditeur de gauche. Utilisez Exemple pour charger du contenu d'exemple. Expérimentez avec gras, italique, listes et tableaux. Pour formater du Markdown existant, utilisez le Formateur Markdown.

3

Copier ou télécharger

Copiez l'aide-mémoire dans le presse-papiers ou téléchargez-le en fichier .md. Pour convertir Markdown en HTML, utilisez Markdown vers HTML. Pour une table des matières depuis les titres, utilisez le Générateur TOC Markdown.

Référence rapide

Syntaxe Markdown essentielle

Markdown :

# Heading 1
## Heading 2

**bold** and *italic* and `code`

- List item 1
- List item 2

[Link text](https://example.com)

> Blockquote

Rendu :

Large heading
Medium heading

Bold text, italic text, and inline code

Bulleted list with two items

Clickable hyperlink

Indented block quote

Où un aide-mémoire aide

Les nouveaux utilisateurs de Markdown ont besoin d'une référence rapide. Le Markdown Guide et la doc GitHub offrent des tutoriels ; un aide-mémoire les complète avec des exemples copier-coller. Tableaux, listes de tâches et blocs de code sont courants dans les README et la documentation.

Pour linter le Markdown sur les problèmes de style, utilisez le Linter Markdown. Pour valider la syntaxe, utilisez le Validateur Markdown. Pour convertir HTML en Markdown, utilisez HTML vers Markdown.

Questions fréquentes

Quelle est la différence entre Markdown et HTML ?

Markdown est un langage de balisage léger qui se convertit en HTML. Au lieu d'écrire <strong>gras</strong> vous écrivez **gras**. Markdown est plus rapide à écrire et plus lisible en texte brut. Il est largement utilisé pour la documentation, les fichiers README et la rédaction de contenu.

Markdown est-il identique partout ?

Pas tout à fait. La spécification originale de Markdown laisse quelques ambiguïtés, donc les plateformes implémentent des légères variantes. CommonMark est la spécification standardisée suivie par la plupart des outils. GitHub Flavored Markdown (GFM) ajoute des extras comme les listes de tâches et les tableaux.

Comment ajouter un saut de ligne en Markdown ?

Terminez une ligne avec deux espaces ou plus avant d'appuyer sur Entrée, ou utilisez un backslash \ en fin de ligne. Certains parseurs traitent aussi une ligne vide entre les paragraphes comme un saut. Le comportement varie légèrement selon les variantes de Markdown.

Puis-je utiliser du HTML dans Markdown ?

Oui — la plupart des parseurs Markdown autorisent du HTML brut en ligne. Vous pouvez utiliser <br>, <div>, <span> et la plupart des balises HTML directement dans les fichiers Markdown. Utile pour centrer du contenu ou ajouter des styles personnalisés.

Mes données sont-elles privées ?

Oui. Tout s'exécute dans votre navigateur. Aucun contenu n'est envoyé à un serveur.

Outils associés

En savoir plus : CommonMark, spécification CommonMark, GitHub Flavored Markdown, Markdown Guide, GitHub.