Table des matières

Prérequis

Pour écrire en Markdown vous devez disposer au minimum de :

• Editeur de texte
• Lecteur Markdown

Si vous ne savez pas quoi choisir, vous pouvez essayer le logiciel Obsidian qui fait les deux à la fois ou bien le logiciel Visual Studio Code avec l'extension Markdown All In One.

La syntaxe est très simple voici les bases.

Titres

Il y a 6 niveaux de titres, les voici :

Commande	Résultat
# Titre 1	Titre 1
## Titre 2	Titre 2
### Titre 3	Titre 3
#### Titre 4	Titre 4
##### Titre 5	Titre 5
###### Titre 6	Titre 6

Accentuation

Voici la syntaxe pour les accentuations en Markdown :

Commande	Résultat
*Italique*	Italique
**Gras**	Gras
***Italique et gras***	Italique et gras

Pour mettre un bloc en valeur, on utilise la syntaxe suivante :

> Bloc à mettre en valeur  

Ce qui donne :

Bloc à mettre en valeur

Pour mettre une barre horizontale, on peut mettre ---.
Par contre il faut laisser une ligne vide au-dessus et en-dessous des ---.

Paragraphes

Pour écrire un paragraphe on écrit normalement, les retours à la ligne se font en ajoutant deux espaces en fin de ligne et en retournant à la ligne.

Listes

Pour les listes non-numérotées, on utilise le symbole -.
Pour les listes numérotées, on procède avec le numéro suivi d'un point.
Exemple :

1. Elément 1
2. Elément 2
3. Elément 3

Si vous souhaitez mettre un point après un nombre sans qu'il devienne un numéro de liste, vous pouvez mettre un \ pour annuler la signification du point.

Lister du code

Pour lister du code on peut l'encadrer entre ` ` pour le lister dans un paragraphe ou bien entre ``` ``` pour le faire dans un bloc dédié.

Liens

Pour mettre des liens en Markdown il suffit d'utiliser la syntaxe suivante :

[Texte du lien](lien "Texte affiché quand on survole le lien")

Exemple :

[Eravyschool](https://school.eravys.fr "Eravyschool")

Eravyschool

Images

Pour intégrer une image, la syntaxe est presque identique à celle d'un lien :

![Nom de l'image](/chemin/image "Texte quand on survole l'image")

Exemple :

![Eravyschool](img/eravyschool.ico "Logo Eravyschool")

Remarque : Il est possible de combiner lien et image avec la syntaxe suivante :

Exemple:

[![Eravyschool](img/eravyschool.ico "Lien vers Eravyschool")](https://school.eravys.fr)

Tableaux

Pour créer un tableau, on utilise une syntaxe de ce style :

        |Colonne1|Colonne2|Colonne3|
        |-|-|-|
        |Contenu1|Contenu2|Contenu3|
      

On peut rendre le tableau plus uniforme comme ceci :

        |Colonne1|Colonne2|Colonne3|
        |----------|----------|----------|
        |Contenu1|Contenu2|Contenu3|