Markdown Preview
Understand Markdown Preview
Cet aperçu convertit le Markdown en HTML au fil de la frappe, pour que vous voyiez comment sortira un README ou un long commentaire.
How it works
Le Markdown est converti par un jeu de règles appliquées dans l'ordre : d'abord les blocs de code délimités, dont le contenu est échappé et laissé intact, puis les titres, les citations, les règles, les listes, le code en ligne, le gras, l'italique et les liens. Le HTML obtenu est filtré contre une liste d'autorisation — titres, paragraphes, listes, code, pre, strong, em, blockquote, hr, br et liens — et tout attribut autre qu'un href en http, https ou mailto est supprimé, si bien que du HTML brut présent dans la source ne peut pas s'exécuter.
When to use it
- Vérifier les titres et les blocs de code d'un README avant de le pousser.
- Voir si un long corps de ticket ou un commentaire s'affichera comme vous l'entendiez.
- Convertir un extrait Markdown en HTML à coller dans un CMS ou un e-mail.
- Tester si une liste ou un bloc de code imbriqué est écrit correctement.
Watch out for
- Ceci est un sous-ensemble de CommonMark, pas du GitHub Flavored Markdown. Tableaux, listes de tâches, texte barré, notes de bas de page et images ne sont pas rendus — leur texte source apparaît à la place.
- Les tirets bas à l'intérieur d'un mot sont lus comme de l'emphase, si bien que snake_case_name s'affiche avec le mot du milieu en italique. CommonMark ne fait délibérément pas cela ; entourez les identifiants d'accents graves.
- L'imbrication est superficielle. Une liste dans une citation, ou une sous-liste indentée, ne sortira pas comme la produirait un analyseur complet.
- Le HTML brut de la source est réduit à son contenu textuel par l'assainisseur. C'est intentionnel, et cela rend cet aperçu plus strict que GitHub, qui autorise un jeu limité de balises.
Not the right tool for: Confirmer exactement comment GitHub rendra un fichier. GitHub superpose ses propres extensions et son propre assainisseur à CommonMark ; pour un contrôle exact à l'octet près, poussez sur une branche et regardez.
Frequently Asked Questions
Quelle syntaxe Markdown est prise en charge ?
La spécification CommonMark : titres # (1 à 6 niveaux), **gras**, *italique*, `code en ligne`, ```blocs de code délimités```, [liens](url), , listes non ordonnées avec -, listes ordonnées avec 1., citations avec >, règles horizontales ---, et la syntaxe de | tableaux |.
Comment prévisualiser un README GitHub ?
Collez le contenu de votre README.md dans l'éditeur. GitHub utilise un analyseur CommonMark strict, augmenté des extensions GFM (GitHub Flavored Markdown) pour les listes de tâches, les tableaux et le texte barré. L'aperçu s'approche de près du rendu de GitHub.
Puis-je exporter le HTML rendu ?
Oui — cliquez sur « Copier le HTML » pour récupérer la sortie HTML rendue. C'est utile pour coller du contenu mis en forme dans un client de messagerie, dans un CMS qui accepte le HTML en entrée, ou dans un gabarit d'e-mail HTML.
How to Use Markdown Preview
- Paste or type your input in the input area above.
- The tool processes your input automatically or click Run.
- Copy or download the result using the action buttons.
- Use Ctrl+Enter to run quickly from the keyboard.