Markdown Preview
Live Markdown preview
Live Markdown preview S'exécute localement dans votre navigateur
About the
L'aperçu Markdown affiche votre Markdown au fur et à mesure que vous tapez, dans une vue côte à côte, en suivant CommonMark avec les extensions GitHub que la plupart des gens utilisent réellement : tableaux, listes de tâches, blocs de code clôturés, barrés et liens automatiques. C'est le moyen le plus rapide de vérifier un README avant de le valider, car les différences entre ce à quoi ressemble Markdown dans la source et ce à quoi il ressemble rendu ne sont pas évidentes, et la syntaxe des tables en particulier échoue silencieusement lorsqu'un seul tube ou un seul tiret est erroné. Le HTML rendu peut également être copié si vous en avez besoin dans un endroit qui ne traite pas Markdown lui-même.
Where people use the
- Vérifier le rendu d'un README correctement avant de le pousser.
- Rédaction de notes de version ou d'un changelog avec une vue en direct du résultat.
- Conversion d'un document Markdown en HTML pour un CMS qui n'accepte pas Markdown.
- Examiner la pull request Markdown de quelqu'un d'autre et voir à quoi elle ressemblera.
How to use the
- 1
Collez ou écrivez votre Markdown
L'éditeur accepte n'importe quoi, depuis un seul paragraphe jusqu'à un document complet avec des titres, des listes, des liens et des barrières de code.
- 2
Regardez le panneau rendu
L'aperçu est mis à jour à chaque frappe, de sorte qu'une table cassée ou une clôture non fermée s'affiche immédiatement plutôt qu'après une étape de publication.
- 3
Corrigez la source, pas l'aperçu
L'aperçu est en lecture seule. Lorsque quelque chose ne s'affiche pas correctement, la cause est presque toujours une ligne vide manquante avant une liste ou un en-tête de tableau sans ligne de délimiteur.
- 4
Copiez le HTML si vous en avez besoin
Basculez vers la vue HTML pour prendre le balisage généré, ce qui est utile pour le coller dans un CMS qui attend du HTML plutôt que du Markdown.
Conseils et bonnes pratiques
- Laissez une ligne vide avant et après chaque élément de bloc ; les bugs de rendu les plus mystérieux sont une ligne vide manquante.
- Utilisez des blocs de code isolés avec un nom de langue afin que le code soit mis en surbrillance plutôt que traité comme du texte brut.
- Conservez une phrase par ligne dans les documents longs ; cela rend les différences lisibles plus tard.
Questions fréquemment posées
Quelle spécification Markdown est utilisée ?
CommonMark comme base, ainsi que les extensions GitHub Flavored Markdown pour les tableaux, les listes de tâches, le code clôturé et le barré. Cette combinaison couvre le format README sur GitHub, GitLab et la plupart des sites de documentation.
Pourquoi ma table ne s'affiche-t-elle pas ?
Un tableau a besoin d'une ligne d'en-tête suivie immédiatement d'une ligne de délimiteur de tirets, avec une ligne vide avant le bloc. Chaque ligne doit avoir le même nombre de tuyaux que l'en-tête. N'importe lequel de ceux qui manquent transforme le tout en un paragraphe de texte contenant des caractères pipe.
Pourquoi les éléments de ma liste ont-ils fusionné en un seul paragraphe ?
Markdown a besoin d'une ligne vide entre un paragraphe et une liste qui le suit. Sans cela, les marqueurs de liste sont traités comme du texte ordinaire.
Est-ce qu'il prend en charge LaTeX ou les mathématiques ?
Non. Le rendu mathématique nécessite une bibliothèque distincte telle que KaTeX ou MathJax et une syntaxe différente. Une expression de signe dollar sera ici affichée sous forme de texte brut.
Le HTML brut est-il autorisé ?
Oui, le HTML en ligne passe directement, ce que fait également GitHub. Si vous publiez le résultat dans un endroit public, nettoyez-le d'abord, car le HTML brut est également la manière dont les scripts sont injectés.
Où va mon texte ?
Nulle part. L'analyse et le rendu s'effectuent dans votre navigateur avec une bibliothèque JavaScript Markdown. Rien n'est enregistré ou transmis, donc le brouillon disparaît lorsque vous fermez l'onglet, sauf si vous le copiez.