Markdown est un langage simple qui permet de mettre en forme du texte. Par exemple, vous pouvez facilement ajouter des titres, des listes, des liens ou des images à votre texte sans avoir besoin de connaissances techniques particulières. Il peut-être convertit en HTML et de nombreux sites le supportent.
Ce format est utilisé pour différentes utilisation :
- rédaction : les fichiers README dans les projets sur des plateformes comme GitHub/Gitlab sont souvent rédigés en Markdown. Ils permettent de fournir des informations claires sur le projet, son installation, son utilisation…
- documentation : écrire de la documentation pour du code
- prise de notes : permet de structurer rapidement de l’information sans se soucier du formatage
- livre : permet de se concentrer sur le contenu et facilite la conversion vers d’autres format comme le PDF, ePub…
Quelques exemples de noms de fichier couramment utilisé pour le Markdown:
- README.md
- CHANGELOG.md
- INSTALL.md : mode d’emploi
- LICENCE.md : licence du logiciel
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- SECURITY.md
- TODO.md
- INDEX.md
En général, le nom fichier est écrit en majuscules.
Quelques sites l’utilisant :
- Git
- Github
- Gitlab
- Bitbucket
- CMS
- WordPress
- Ghost
- Hugo
- Jekyll
- Communautaire
- Stack Overflow
- Slack
- Discord
- Mattermost
- Squarespace
- Trello
- dev.to
Syntaxe
Obtenir du texte en gras
Voici comment obtenir du texte en **gras**
Obtenir du texte en italique
Voici comment obtenir du texte en *italique*
Obtenir du texte barré
Prix : ~~38€~~
Listes à puces
Ne pas oublier l’espace après le tiret. Vous devez entrer un saut de ligne avant et après la liste.
- puce 1 - puce 2 - puce 3
Listes numérotés
Ne pas oublier l’espace après le chiffre. Vous devez entrer un saut de ligne avant et après la liste.
1. puce 1 2. puce 2 3. puce 3
Listes imbriquées
Dans le texte saisie, pour créer un second niveau, ajoutez deux espaces avant l’astérisque ou le numéro. On peut ajouter des images, des blocs de citation ou des liens à une liste imbriquée, en plus du texte.
- puce 1 - puce 1.1 - puce 1.2 - puce 1.3 - puce 2 - puce 3
Titres
Texte saisie avec un espace après le caractère dièse. On peut créer 6 niveaux de 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
Blocs de citation
Les blocs de citation doivent commencer et finir par une ligne vierge.
Chaque ligne de la citation commence par un chevron fermant et un espace.
> Marcher sur l'eau et développer un logiciel à partir d'une spécification sont faciles si les deux sont gelés.
Code incorporé
Il faut utiliser les accents `arrières` autour du texte.
Il faut utiliser les accents `arrières` autour du texte.
Code
Exemple de code HTML
```html <img src="https://blog.enguehard.info/wp-content/uploads/2023/06/mask-img7.png" alt="texte alternatif"> <p> Lorem, ipsum dolor sit </p> ```
Exemple de code JavaScript
```javascript let s = "Message d'alerte"; alert(s); ```
Insérer une image
Insérer un lien
[Texte d'affichage du lien](https://enguehard.info/)
Insérer un lien avec une image
[](https://enguehard.info)
Insérer une ligne de séparation horizontale
---
Tableaux
Pour créer un tableau vous devez placer une ligne de tirets (-) sous la ligne d’entête et séparer les colonnes avec des |. Vous pouvez aussi préciser l’alignement en utilisant des :| :
| Aligné à gauche | Centré | Aligné à droite | | :--------------- |:---------------:| -----:| | Aligné à gauche | ce texte | Aligné à droite | | Aligné à gauche | est | Aligné à droite | | Aligné à gauche | centré | Aligné à droite |