Chaque élément Markdown avec un exemple que vous pouvez modifier et voir rendu instantanément : retours à la ligne, liens, tableaux, cases à cocher, notes de bas de page, blocs de code et alertes GitHub, plus un modèle de README.
Markdown met en forme du texte brut avec quelques symboles : # pour les titres, **deux astérisques** pour le gras, [texte](adresse) pour les liens, - pour les listes à puces et trois accents graves pour les blocs de code. Chaque exemple ci-dessous est modifiable, et l'aperçu à côté se met à jour pendant la saisie, pour tester une syntaxe avant de l'utiliser.
Les cinq que vous utiliserez le plus
Dix-huit exemples en direct qui couvrent tout, des titres aux notes de bas de page et aux alertes GitHub, un tableau des différences entre GitHub et CommonMark standard, un modèle de README et un éditeur complet en bas de la page.
Terminez la ligne par deux espaces ou une barre oblique inverse, puis appuyez sur Entrée. Une simple pression sur Entrée est traitée comme une espace et les lignes se rejoignent. Pour un nouveau paragraphe plutôt qu'un retour à la ligne, laissez une ligne vide.
Commencez un élément de liste par - [ ] pour une case vide ou - [x] pour une case cochée. Les listes de tâches font partie de GitHub Flavored Markdown, donc elles fonctionnent sur GitHub, GitLab et la plupart des applications de notes, mais pas en CommonMark strict.
Écrivez la ligne d'en-tête avec des barres verticales entre les colonnes, puis une ligne de tirets, puis une ligne par rangée. Les colonnes n'ont pas besoin d'être alignées dans le source. Ajoutez des deux-points à la ligne de tirets pour aligner une colonne à gauche, à droite ou au centre.
Markdown est la syntaxe originale de 2004, qui laissait de nombreux cas non définis. CommonMark est une spécification précise de cette syntaxe de base. GitHub Flavored Markdown est CommonMark plus les tableaux, les listes de tâches, le texte barré, les liens automatiques et les notes de bas de page, et c'est ce que suivent la plupart des outils pour développeurs.
La plupart des moteurs de rendu l'autorisent, donc les balises details et summary ou une image centrée sont courantes dans les README. GitHub supprime les scripts, les styles et certains attributs par sécurité. Les aperçus de cette page n'affichent pas le HTML brut, ils le montrent sous forme de texte.
Un à six signes #, puis une espace. Utilisez un seul titre # par document.
Les tirets bas (__gras__, _italique_) fonctionnent aussi, mais pas au milieu d'un mot.
Deux tildes de chaque côté. Fait partie de GitHub Flavored Markdown, pas du cœur de CommonMark.
Une simple pression sur Entrée ne coupe pas la ligne. Terminez-la par deux espaces ou une barre oblique inverse, ou laissez une ligne vide pour un nouveau paragraphe.
Le texte entre crochets, l'adresse entre parenthèses. Des chevrons rendent une adresse brute cliquable.
Garde les longues adresses hors du texte. Les définitions peuvent être placées n'importe où et ne s'affichent pas.
Comme un lien précédé de !. Le texte entre crochets est le texte alternatif lu par les lecteurs d'écran.
Utilisez -, * ou + pour les puces et 1. pour les numéros. Indentez de deux à quatre espaces pour imbriquer.
Une espace entre les crochets donne une case vide ; un x donne une case cochée. Sur GitHub, vous pouvez les cocher dans les issues.
Commencez chaque ligne par >. Une ligne contenant seulement > garde les paragraphes dans une même citation.
Les accents graves gardent le texte exactement tel qu'il est saisi. Pour afficher un accent grave, entourez avec deux : `` a`b ``.
Trois accents graves avant et après. Le mot qui suit la clôture d'ouverture indique le langage pour la coloration syntaxique.
Les barres verticales séparent les colonnes ; la ligne de tirets est obligatoire. Les deux-points définissent l'alignement : gauche, droite ou centre.
Trois tirets, astérisques ou tirets bas ou plus, seuls sur leur ligne. Laissez des lignes vides autour des tirets pour qu'ils ne soient pas lus comme le soulignement d'un titre.
La note est regroupée en bas du document avec un lien de retour.
Une barre oblique inverse devant * _ # [ ] ` et les caractères similaires les affiche en texte brut.
GitHub transforme les adresses brutes en liens. CommonMark strict exige des chevrons.
GitHub les affiche sous forme d'encadrés colorés ; les autres applications affichent une simple citation, comme l'aperçu ici.
Syntaxe Markdown et où elle fonctionne
Différences entre GitHub Flavored Markdown et CommonMark
Partout
GitHub et la plupart des applications
GitHub uniquement
Markdown (modifiez-moi)
Aperçu
Copier
Réinitialiser
La syntaxe en un coup d'œil
Chaque élément, en direct
GitHub ou CommonMark
Modèle de README
Copier le modèle
Ouvrir dans l'éditeur
Éditeur complet
Markdown
Copier le Markdown
{n} mots. Rien n'est enregistré ni envoyé.
Commencer gratuitement · Sans carte bancaire