Aperçu Markdown

Prévisualiser des documents Markdown

Prévisualiser des documents Markdown0 caractères / 0 lignes
Source Markdown
Aperçu
L’aperçu apparaît ici

Guide de l’outil

À propos de Aperçu Markdown

Markdown Preview rend la source Markdown en aperçu lisible pour vérifier titres, listes, liens, citations, tableaux et blocs de code.

Utilisez-le avant de soumettre README, extrait de documentation, issue ou brouillon de blog.

Comment utiliser Markdown Preview

  1. Collez votre source Markdown.
  2. Utilisez l’exemple pour vérifier tableaux GFM, fenced code blocks et liens.
  3. Relisez hiérarchie de titres, indentation des listes et rendu des liens.

Cas d’utilisation

  • Vérifier langages de code blocks et alignement des tableaux avant commit README.
  • Prévisualiser une issue GitHub ou release note avant publication.
  • Inspecter des snippets de documentation API pour titres et listes imbriquées.

Syntaxe Markdown et pièges de format

Markdown est léger, mais lignes vides, indentation et nombre de backticks changent le rendu. GitHub Flavored Markdown ajoute tableaux, task lists et fenced code blocks.

  • Les titres utilisent # et doivent suivre une hiérarchie logique.
  • Les listes imbriquées dépendent de l’indentation; tabs et espaces mélangés cassent souvent le layout.
  • Les fenced code blocks utilisent trois backticks et peuvent préciser un langage.
  • Le texte de lien doit être descriptif, pas seulement “click here”.

Questions fréquentes sur Aperçu Markdown

Supporte-t-il GitHub Flavored Markdown?
Les fonctions GFM courantes comme tableaux, fenced code blocks et task lists sont prévisualisées, mais le rendu final dépend de la plateforme cible.
Pourquoi ma liste imbriquée échoue?
Souvent indentation ou lignes vides. Indentez les enfants plus que le parent et gardez le même style de marqueur.
Mon contenu est-il envoyé?
Non. Le rendu Markdown s’exécute localement dans le navigateur et n’est pas envoyé à wetool.site.

Markdown Preview vs publication

L’aperçu détecte beaucoup de problèmes, mais GitHub, npm, forums et CMS peuvent utiliser d’autres extensions Markdown et sanitizers. Revérifiez sur la plateforme cible.

Comparaison des dialectes Markdown

Un aperçu aide à trouver les problèmes de structure, mais les dialectes Markdown varient selon les plateformes.

  • CommonMark couvre la syntaxe de base: headings, paragraphs, lists, blockquotes et code blocks.
  • GitHub Flavored Markdown ajoute tables, task lists, strikethrough et autolinks.
  • Blogs, CMS et documentation sites peuvent ajouter front matter, heading anchors, footnotes ou math formulas.

Rendu sûr et limites de publication

Markdown preview n’est pas l’environnement final de publication, surtout pour HTML, images, external links et platform filters.

  • Ne traitez pas untrusted Markdown comme safe HTML; les plateformes cibles sanitize souvent raw HTML.
  • External images et links peuvent exposer request sources, token parameters ou internal addresses après publication.
  • Avant README, npm docs ou CMS pages, vérifiez le final rendering sur la plateforme cible.