La syntaxe markdown

Basiques

Titres
  • # Mon titre h1 {#h1-id}
  • ## Mon titre h2 {#h2-id}
  • ### Mon titre h3 {#h3-id}
  • #### Mon titre h4 {#h4-id}
  • ##### Mon titre h5 {#h5-id}
  • ###### Mon titre h6 {#h6-id}
{#-id} sont facultatives mais utiles pour définir des ancres.
Gras **Mon texte en gras**
Italique *Mon texte en italique*
Code `Mon code en ligne`
Citations > ma citation
Image ![texte alternatif](/chemin/vers/image)
Lien [texte du lien](https://URL)
ol (liste ordonnée)
  • 1. item 1
  • 2. item 2
  • 3. item 3
ul (liste non ordonnée)
  • - item 1
  • - item 2
  • - item 3
hr ---
Strike ~texte barré~

Notions avancées

Ancres [texte de l'ancre](#ancre)
Code ```
package main
import "fmt"
func main() {
    fmt.Println("Bazinga!")
}
```
Liste de tâches (e.g. Pull Request GitHub)
  • - [x] Optimisation
  • - [ ] Bug
  • - [ ] Fonctionnalité
Note de bas de page Ma note. [^1]

[^1]: C'est ma note expliquée.
Tableau Colonne | Colonne | Colonne
:----- | :----: | -----:
Gauche | Centré | Droite
aligné | aligné | aligné

  • : alignements
  • - séparer le corps de l'entête
  • | est un séparateur de colonnes.
  • Markdown ignore les espaces, pas besoin d'égaliser.

Cas particuliers et éléments imbriqués

Gras ET italique ***Texte gras et italique***
Image en tant que reference ![Oiseau chantant][1]
[1]: https://upload.wikimedia.org/wikipedia/commons/9/9a/Giphyvv.gif
Citations imbriquées >> Ma citation imbriquée
Listes imbriquées
* Fruit
- Second niveau
+ Troisième niveau
L'indentation et les caractères comme (*, - et +) permettent d'imbriquer les listes. Vous pouvez combiner ol et ul.

Formatage

Nouveau paragraphe Ajoutez une ligne vide
Saut de ligne Utilisez 2 espaces minimum à la fin de la ligne et appuyez sur entrée
Indentation du code Utilisez 4 espaces ou une tabulation

Variations

La syntaxe markdown peut différer d’un système/framework à l’autre. En général, ce sera indiqué dans la documentation du CMS ou de l’outil en question.

tableau GitHub