Aide-mémoire Markdown

Référence rapide pour la syntaxe et le formatage Markdown

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 <strong>Exemple</strong> 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 <code>.md</code>. 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.

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

CommonMark vs GFM ?

CommonMark est la spécification de base. GFM ajoute les tableaux, listes de tâches, barré et autolinks. La plupart des plateformes (GitHub, GitLab) supportent GFM.

Comment échapper les caractères spéciaux ?

Utilisez un backslash avant *, _, #, [, etc. Par exemple, \* affiche un astérisque littéral.

Puis-je l'utiliser hors ligne ?

Téléchargez l'aide-mémoire en fichier .md. Gardez-le dans votre projet ou dossier docs pour référence rapide.

Aide-mémoire vs guide de syntaxe ?

Un aide-mémoire fournit une référence compacte copier-coller pour la syntaxe Markdown.

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

Formateur Markdown Générateur de tableaux Markdown Générateur TOC Markdown Markdown vers HTML Linter Markdown Validateur Markdown Formatage JSON

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