Aperçu Markdown
Aperçu Markdown en direct avec un moteur léger : titres, emphases, code, tableaux et listes de tâches. Pas une implémentation complète de CommonMark ni de GFM. Traitement côté client.
Le rendu est un sous-ensemble léger : titres, emphases, code, tableaux et listes de tâches. Barré, autoliens et info strings ne sont pas implémentés. Le rendu est local.
Espace de travail
Commencez à taper pour voir l'aperçu...
GitHub Flavored Markdown (sous-ensemble)
Les tableaux et les listes de tâches sont pris en charge ; barrés, autolinks et info-strings de bloc de code ne le sont pas.
Diagrammes Mermaid
Créez des organigrammes, diagrammes de séquence et plus avec la syntaxe Mermaid dans les blocs de code.
Aperçu en direct
L'aperçu en direct se met à jour pendant la saisie. Aucune donnée envoyée au serveur.
Votre contenu Markdown est traité localement dans votre navigateur. Aucune donnée n'est envoyée à un serveur.
Référence : un essai réel, les paramètres et les erreurs
Exemple déroulé
Un titre et une ligne en gras
Entrée
## Local check
**No upload**Sortie
<h2>Local check</h2><br><br><strong>No upload</strong>Comment vérifier: Passez en Aperçu : la première ligne est un H2, la seconde est en gras. La ligne vide devient un élément br, car ce rendu travaille ligne par ligne et n'est pas un analyseur de blocs CommonMark complet.
Paramètres
| Paramètre | Valeur | Par défaut | Limite |
|---|---|---|---|
| Syntaxe | Titres, emphase, code, tableaux, listes de tâches, listes, citations, règles, liens, images | — | Un sous-ensemble GFM léger, pas CommonMark complet |
| HTML | Échappé avant le rendu | — | Le HTML brut et les gestionnaires d'événements ne peuvent pas s'exécuter |
| Liens et images | http, https, mailto, tel, ftp, ftps, chemins relatifs | — | Les autres schémas deviennent # |
| Mermaid | Bloc mermaid clôturé | — | Chargé à la demande ; les erreurs de syntaxe restent dans le bloc |
| Taille d'entrée | Aucune limite dure de caractères | — | Les très gros documents peuvent ralentir l'aperçu et le PDF |
| A4 portrait, aperçu rasterisé | — | Le texte du PDF n'est pas sélectionnable |
Erreurs et remèdes
| Symptôme | Cause probable | Que faire |
|---|---|---|
| Le HTML brut apparaît comme du texte. | Le HTML est échappé par conception. | Utilisez la syntaxe Markdown ; le HTML non assaini n'est pas transmis. |
| Un tableau s'affiche comme du texte. | La ligne de séparation sous l'en-tête manque ou est mal formée. | Ajoutez une ligne comme | --- | --- | sous l'en-tête. |
| Un lien ne fait rien. | L'URL utilise un schéma hors de la liste autorisée. | Utilisez https:, mailto:, tel: ou un chemin relatif. |
| Le bloc Mermaid affiche une erreur. | La source du diagramme est invalide ou le module n'a pas chargé. | Corrigez la syntaxe du diagramme ; le reste de l'aperçu reste visible. |
| Le PDF est vide ou lent. | L'aperçu n'était pas terminé ou le document est très gros. | Attendez l'aperçu, puis exportez ; découpez les documents longs. |
Cas d'utilisation
- 1Prévisualiser le Markdown GitHub Flavored avant d'ouvrir une pull request ou de publier une documentation
- 2Rendre les tableaux, listes de tâches et blocs de code lors de la rédaction de README ou notes de version
- 3Vérifier la mise en forme finale et exporter avant de partager
- 4Prototyper du Markdown pour les modèles d'issue et les wikis de projet
Questions fréquentes
Quelle syntaxe Markdown est prise en charge ?
Un sous-ensemble léger de GitHub Flavored Markdown : tableaux, blocs de code délimités et listes de tâches. Les barrés et les autolinks ne sont pas implémentés, et l'info-string des blocs de code n'est pas conservé.
Puis-je exporter le résultat ?
Oui. Exportez l'aperçu en PDF ou copiez la source Markdown pour la réutiliser où vous voulez.
Votre contenu est-il traité sur un serveur ?
Non. L'aperçu est rendu localement dans votre navigateur.
Le HTML brut dans Markdown peut-il exécuter des scripts ?
Le HTML brut est échappé avant la construction de l'aperçu, et les URL des liens et images sont limitées à des protocoles comme https, mailto et tel. L'aperçu ne peut donc pas exécuter de scripts ni de gestionnaires d'événements intégrés.
Que se passe-t-il lorsqu'un diagramme Mermaid échoue ?
Le bloc du diagramme affiche l'erreur au lieu de laisser une zone vide, et le reste du document continue d'être rendu. Un diagramme cassé ne masque pas les sections voisines.
Guides associés
Outils connexes
Vous êtes responsable de la gestion des clés et de la validation des résultats.