Guide de Syntaxe Markdown

Markdown est un langage de balisage lĂ©ger conçu pour ĂȘtre converti en HTML. Il est souvent utilisĂ© pour formater des fichiers README, pour Ă©crire des messages dans des forums en ligne, et pour crĂ©er des documents texte riches en utilisant un Ă©diteur de texte brut. Son objectif principal est la lisibilitĂ© et la facilitĂ© d’utilisation.

Qu’est-ce que Markdown ?

Markdown a Ă©tĂ© crĂ©Ă© en 2004 par John Gruber avec l’aide d’Aaron Swartz, avec l’idĂ©e de permettre aux gens d’écrire en utilisant un format de texte brut facile Ă  lire et Ă  Ă©crire, qui pourrait ĂȘtre converti en HTML de maniĂšre transparente.

Pourquoi utiliser Markdown ?

  • SimplicitĂ© et facilitĂ© d’apprentissage : La syntaxe de Markdown est trĂšs simple Ă  apprendre, ce qui en fait un bon choix pour ceux qui ne sont pas familiers avec les langages de balisage plus complexes comme HTML.
  • PortabilitĂ© : Les fichiers Markdown sont des fichiers texte brut, donc ils sont lĂ©gers et compatibles avec de nombreuses plateformes et Ă©diteurs de texte.
  • FlexibilitĂ© : Markdown est souvent utilisĂ© pour la documentation de projets, les fichiers README, et les forums en ligne, mais il peut Ă©galement ĂȘtre utilisĂ© pour crĂ©er des livres, des prĂ©sentations et d’autres types de documents.
  • Conversion en d’autres formats : Il est facile de convertir des fichiers Markdown en HTML, PDF, et d’autres formats.

Comment utiliser ce guide ?

Ce guide fournit des exemples de la syntaxe de base de Markdown. Vous pouvez vous référer à ce guide pour comprendre comment formater vos textes en Markdown.

Titres

Les titres sont créés en utilisant le symbole #. Le nombre de # détermine le niveau du titre.

# Titre de niveau 1
## Titre de niveau 2
### Titre de niveau 3
#### Titre de niveau 4
##### Titre de niveau 5
###### Titre de niveau 6

Texte en gras et en italique

Texte en italique s’écrit en entourant le texte de * ou de _. Texte en gras utilise deux * ou _ de chaque cĂŽtĂ©. Texte en gras et en italique combine les deux.

*Texte en italique*
_Texte en italique_
**Texte en gras**
__Texte en gras__
***Texte en gras et en italique***

Listes

Listes non ordonnées

Utilisez *, +, ou - pour les éléments de la liste.

* ÉlĂ©ment 1
* ÉlĂ©ment 2
  * Sous-élément 2.1
  * Sous-élément 2.2

Listes ordonnées

Les nombres suivis d’un point crĂ©ent une liste ordonnĂ©e.

1. Premier élément
2. DeuxiÚme élément
   1. Sous-élément 2.1
   2. Sous-élément 2.2

Liens

Pour crĂ©er un lien, mettez le texte du lien entre crochets [] et l’URL entre parenthĂšses ().

[OpenAI](https://www.openai.com)

Images

Les images sont similaires aux liens, mais avec un point d’exclamation ! devant.

![Alt text](url_de_l'image.jpg)

Citations

Les citations sont créées en utilisant le symbole >.

> Ceci est une citation.

Code

Pour un bloc de code, utilisez trois backticks ` ou quatre espaces d’indentation. Pour du code inline, utilisez un seul backtick.

    Ceci est un bloc de code

`Ceci est du code inline`

Exemple :

// Code Arduino pour faire clignoter une LED
void setup() {
  pinMode(13, OUTPUT); // Initialise la broche 13 en tant que sortie
}

void loop() {
  digitalWrite(13, HIGH);   // Allume la LED
  delay(1000);              // Attend une seconde
  digitalWrite(13, LOW);    // Éteint la LED
  delay(1000);              // Attend une seconde
}

Lignes horizontales

Utilisez trois ou plus de *, -, ou _ pour créer une ligne horizontale.

---

Tableaux

Créez des tableaux en séparant les textes par des barres verticales | et des tirets -.

| En-tĂȘte 1 | En-tĂȘte 2 |
| --------- | --------- |
| Cellule 1 | Cellule 2 |
| Cellule 3 | Cellule 4 |

Aller plus loin

Si vous souhaitez aller plus loin, vous pouvez vous rendre sur la page de documentation du template du site “Just the Docs”.