Table des matières
- Introduction
- Syntaxe de base
- Fonctionnalités avancées
- Rendu et compatibilité
- Exemples pratiques
- Conclusion
Introduction
Markdown a été créé par John Gruber en 2004. Il est largement utilisé sur des plateformes comme GitHub, Reddit, Stack Overflow, et les blogs pour sa simplicité et sa lisibilité.
Syntaxe de base
Titres
Markdown permet de créer des titres 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
Affichage rendu :
Titre de niveau 1
Titre de niveau 2
Titre de niveau 3
Texte en gras et en italique
- Gras : Utilisez
**ou__autour du texte. - Italique : Utilisez
*ou_autour du texte. - Gras et italique : Utilisez une combinaison de
***.
Exemples :
**Texte en gras**
*Texte en italique*
***Texte en gras et italique***
Affichage rendu :
Texte en gras
Texte en italique
Texte en gras et italique
Listes
Listes à puces
Utilisez des -, *, ou + pour créer une liste à puces.
- Élément 1
- Élément 2
- Sous-élément
* Élément 3
Affichage rendu :
- Élément 1
- Élément 2
- Sous-élément
- Élément 3
Listes numérotées
Utilisez des nombres suivis d’un point.
1. Élément 1
2. Élément 2
1. Sous-élément
3. Élément 3
Affichage rendu :
- Élément 1
- Élément 2
- Sous-élément
- Élément 3
Liens et images
Liens
Utilisez la syntaxe suivante :
[Texte du lien](URL)
Exemple :
[Visitez OpenAI](https://www.openai.com)
Affichage rendu : Visitez OpenAI
Images
Utilisez ! avant la syntaxe du lien.
Exemple :
Affichage rendu :
Citations
Utilisez > au début d’une ligne pour créer une citation.
> Ceci est une citation.
> Elle peut s'étendre sur plusieurs lignes.
Affichage rendu :
Ceci est une citation.
Elle peut s’étendre sur plusieurs lignes.
Code
Code en ligne
Encadrez le texte avec des accents graves (`).
Voici un exemple de `code en ligne`.
Affichage rendu : Voici un exemple de code en ligne.
Blocs de code
Utilisez trois accents graves (```) pour créer un bloc de code.
print("Hello, world!")
Affichage rendu :
print("Hello, world!")
Fonctionnalités avancées
Tables
Créez des tables en utilisant des barres verticales (|) et des tirets (-).
| Colonne 1 | Colonne 2 | Colonne 3 |
|-----------|------------|-----------|
| Ligne 1 | Donnée 1 | Donnée 2 |
| Ligne 2 | Donnée 3 | Donnée 4 |
Affichage rendu :
| Colonne 1 | Colonne 2 | Colonne 3 |
|---|---|---|
| Ligne 1 | Donnée 1 | Donnée 2 |
| Ligne 2 | Donnée 3 | Donnée 4 |
Blocs de code multiligne
Pour afficher du code sur plusieurs lignes, utilisez trois accents graves ou trois tildes.
def hello_world(): print("Hello, world!")
Affichage rendu :
def hello_world():
print("Hello, world!")
Ancrages
Les titres définissent automatiquement des ancres pour les liens internes. Par exemple, un titre comme :
## Fonctionnalités avancées
peut être référencé par un lien interne :
[Aller à la section Fonctionnalités avancées](#fonctionnalites-avancees)
Rendu et compatibilité
Markdown est pris en charge par de nombreuses plateformes, chacune pouvant ajouter ses propres extensions ou variations (ex : GitHub Flavored Markdown). Les outils populaires incluent :
- Visual Studio Code (prévisualisation intégrée)
- GitHub (pour la documentation)
- Markdown Here (extension pour navigateurs)
Exemples pratiques
Voici quelques exemples de documents pratiques créés avec Markdown :
- Document simple : Un résumé ou un article.
- Document technique : Une documentation technique avec du code, des tables et des listes.
- Liste de tâches (checklist) :
- [x] Terminer le guide Markdown
- [ ] Relire et corriger les erreurs
- [ ] Publier le document
Affichage rendu :
- Terminer le guide Markdown
- Relire et corriger les erreurs
- Publier le document
Conclusion
Markdown est un outil puissant et simple à utiliser pour créer du texte formaté. Grâce à sa syntaxe légère, il améliore la lisibilité et facilite la gestion des documents. Que vous soyez développeur, blogueur ou rédacteur, Markdown peut vous aider à produire rapidement des documents élégants.