L'essentiel dans un tableau
Markdown a été conçu pour qu'un fichier texte reste lisible avant même d'être converti. Un titre ressemble à un titre parce qu'il commence par un dièse, et une liste ressemble à une liste parce que chaque ligne commence par un tiret. Quand le texte est affiché sur GitHub, dans une application de notes ou dans l'éditeur ci-dessous, les marques deviennent une vraie mise en forme.
Le tableau regroupe les marques dont vous aurez le plus souvent besoin. Copiez un exemple dans l'éditeur pour voir ce qu'il donne.
| Élément | Écriture | Résultat |
|---|---|---|
| Titre de niveau 1 à 6 | # Titre, ## Section, ### Sous-section | Titres de taille décroissante |
| Gras | **gras** ou __gras__ | texte en gras |
| Italique | *italique* ou _italique_ | texte en italique |
| Gras et italique | ***les deux*** | texte en gras italique |
| Barré | ~~ancien prix~~ | texte barré |
| Code dans le texte | `npm install` | code en police à chasse fixe |
| Lien | [Anyfeat](https://anyfeat.com) | texte cliquable |
| Image |  | une image avec texte alternatif |
| Liste à puces | - élément (ou * élément, + élément) | une puce |
| Liste numérotée | 1. premier | un élément numéroté |
| Liste de tâches | - [ ] à faire et - [x] fait | des cases à cocher |
| Citation | > texte cité | une citation en retrait |
| Ligne de séparation | *** seul sur une ligne | une ligne horizontale |
Essayez ici : Éditeur Markdown
Ouvrir la page complète de l'outilTitres, paragraphes et retours à la ligne
Commencez une ligne par un à six dièses suivis d'un espace pour créer un titre ; le nombre de dièses donne le niveau. La plupart des documents utilisent un titre de niveau 1 pour le titre principal et des titres de niveau 2 et 3 pour les sections. L'erreur la plus fréquente est d'oublier l'espace après le dièse : #Titre reste du texte simple sur GitHub.
Un paragraphe est formé d'une ou plusieurs lignes de texte, séparé du suivant par une ligne vide. Un simple retour à la ligne à l'intérieur d'un paragraphe est ignoré à la conversion, ce qui surprend beaucoup de monde. Pour forcer un retour à la ligne, terminez la ligne par deux espaces ou une barre oblique inverse. Les commentaires GitHub et certaines messageries traitent chaque retour à la ligne comme un saut de ligne ; dans l'éditeur ci-dessus, activez Retours à la ligne comme dans les commentaires GitHub pour obtenir le même comportement.
Sur GitHub et dans l'éditeur ci-dessus, chaque titre reçoit aussi une ancre, une version en minuscules de son texte où les espaces deviennent des tirets. Un titre Premiers pas peut être lié avec [voir l'installation](#premiers-pas) : c'est ainsi que fonctionnent les tables des matières des fichiers README.
Listes et listes de tâches
Les listes à puces commencent chaque ligne par un tiret, un astérisque ou un signe plus suivi d'un espace. Les listes numérotées utilisent un nombre et un point. Les nombres n'ont pas besoin d'être justes : une liste écrite 1. 1. 1. s'affiche quand même 1, 2, 3. Le premier nombre compte en revanche, donc une liste qui commence par 3. démarre à 3.
Pour imbriquer une liste, décalez les éléments intérieurs afin qu'ils s'alignent sur le texte de l'élément du dessus, soit deux espaces sous un tiret et trois sous 1. Quatre espaces fonctionnent aussi dans la plupart des outils. Une ligne vide entre les éléments donne une liste aérée avec plus d'espace ; sans lignes vides, la liste reste compacte.
Les listes de tâches sont une extension de GitHub : écrivez - [ ] pour une tâche ouverte et - [x] pour une tâche terminée. Elles deviennent des cases à cocher. Dans l'éditeur de cette page, vous pouvez cocher une case dans l'aperçu, et le [ ] de votre texte devient [x].
Liens, images et références
Un lien se compose du texte visible entre crochets suivi de l'adresse entre parenthèses : [Anyfeat](https://anyfeat.com). Un titre qui apparaît au survol se met entre guillemets après l'adresse. Une adresse entre chevrons, comme <https://anyfeat.com>, devient un lien qui affiche l'adresse elle-même, et sur GitHub les adresses simples qui commencent par https:// ou www. sont liées automatiquement.
Les images suivent le même modèle avec un point d'exclamation devant : . Le texte entre crochets est le texte alternatif, lu par les lecteurs d'écran et affiché quand l'image ne se charge pas. Décrivez donc ce que montre l'image.
Dans les longs documents, les liens de référence gardent le texte lisible : écrivez [le guide][1] dans le texte et placez [1]: https://example.com sur une ligne à part n'importe où dans le fichier. La ligne de définition elle-même n'apparaît pas dans le résultat.
Tableaux
Les tableaux font partie du GitHub Flavored Markdown et fonctionnent sur GitHub, GitLab, dans la plupart des outils de documentation et dans l'éditeur ci-dessus, mais pas dans toutes les applications Markdown. Écrivez les cellules d'en-tête séparées par des barres verticales, puis une ligne de séparation avec des tirets, puis une ligne par rangée :
| Offre | Prix |, puis |:-|-:|, puis | Équipe | 49 |. Chaque cellule de la ligne de séparation demande au moins un tiret ; on en met souvent trois, plus faciles à lire. Deux-points à gauche des tirets alignent la colonne à gauche, deux-points des deux côtés la centrent, et deux-points à droite l'alignent à droite, ce qui convient aux nombres.
Les barres n'ont pas besoin d'être alignées, et les barres extérieures sont facultatives. Pour mettre une barre verticale dans une cellule, écrivez \|. Les retours à la ligne dans une cellule sont impossibles en Markdown pur ; utilisez <br> là où le HTML est autorisé. Le bouton Tableau de l'éditeur insère un tableau prêt de trois colonnes à remplir.
Code et citations
Pour un court bout de code dans une phrase, entourez-le d'accents graves simples : `git status`. Pour plusieurs lignes, mettez trois accents graves sur la ligne avant et après le code. Un nom de langage juste après les accents graves d'ouverture, comme js, python ou sql, permet à GitHub et aux outils de coloration de colorer le code ; l'éditeur de cette page le conserve comme classe sur l'élément code dans le HTML exporté. Les lignes décalées de quatre espaces s'affichent aussi comme du code.
Tout ce qui est dans du code s'affiche exactement comme tapé : c'est donc le bon endroit pour les symboles que Markdown interpréterait autrement, comme les astérisques et les tirets bas. Hors du code, placez une barre oblique inverse devant un symbole pour l'afficher tel quel : \* donne un astérisque simple.
Les citations commencent par > et peuvent contenir d'autre Markdown, y compris des listes et d'autres citations avec >>. On les utilise pour les citations, les notes et les réponses dans les discussions.
Différences entre les applications Markdown
La syntaxe de base ci-dessus fonctionne presque partout. Les différences se trouvent dans les extensions : GitHub prend en charge les tableaux, les listes de tâches, le texte barré, les liens automatiques et les encadrés écrits > [!NOTE] ; Obsidian ajoute des liens entre notes entre doubles crochets ; certains outils gèrent les notes de bas de page et les formules mathématiques. L'éditeur de cette page suit GitHub pour les tableaux, les listes de tâches, le texte barré, les liens automatiques et les ancres de titres, mais ne gère ni les notes de bas de page, ni les formules, ni les encadrés.
La plupart des applications Markdown acceptent aussi un peu de HTML. Des balises comme <br>, <sub>, <sup>, <kbd> et <details> fonctionnent dans l'éditeur ci-dessus, tandis que les scripts, les styles et les attributs d'événements sont toujours supprimés, comme sur GitHub.