Skip to main content

MarkDown (MD) - Guide exhaustif – Principe, usages et référence

Ce document est une notice complète et progressive sur Markdown.
Il est conçu pour :

  • démarrer rapidement,
  • comprendre les principes avancés,
  • servir de référence rapide.

Markdown est utilisé ici comme langage de documentation principal, notamment dans des outils comme BookStack, Git, Wiki techniques et documentations projet.

PARTIE 1 — DÉMARRAGE RAPIDE

1. Principe de base

Markdown est un langage de balisage léger.

  • Le texte reste lisible brut
  • La mise en forme est déclarative
  • Le rendu est généré automatiquement (HTML, PDF, Wiki…)

👉 Objectif : écrire d’abord, mettre en forme ensuite.

2. Titres

# Titre niveau 1
## Titre niveau 2
### Titre niveau 3
#### Titre niveau 4

Bonnes pratiques :

  • Un seul # par page (titre principal)
  • Hiérarchie logique

3. Paragraphes et retours à la ligne

Ceci est un paragraphe.

Ceci est un autre paragraphe.

Retour à la ligne forcé :

Ligne 1  
Ligne 2

(deux espaces en fin de ligne)

4. Mise en valeur du texte

*italique*
**gras**
***gras italique***
~~texte barré~~

Résultat :

  • italique
  • gras
  • gras italique
  • texte barré

5. Listes

Liste non ordonnée

- Élément A
- Élément B
  - Sous-élément

Liste ordonnée

1. Étape 1
2. Étape 2

6. Liens

[Titre du lien](https://exemple.com)

7. Images

![Texte alternatif](image.png)

8. Code

Code en ligne

Utiliser la commande `ls -l`

Bloc de code

```bash
ls -l


---

# PARTIE 2 — PRINCIPES AVANCÉS

## 9. Citations

```md
> Ceci est une citation

Ceci est une citation

10. Tableaux

| Colonne | Description |
|--------|-------------|
| A      | Texte       |
| B      | Texte       |

11. Listes de tâches

- [x] Tâche faite
- [ ] Tâche à faire

12. Ancres internes

[Voir la section](#partie-2--principes-avancés)

Les ancres sont générées automatiquement à partir des titres.

13. Séparateurs

---

14. Échappement des caractères

\* \# \-

Affiche : * # -

15. HTML intégré

Markdown autorise l’HTML brut.

<div style="color:red">
Texte rouge
</div>

⚠️ À utiliser avec parcimonie.

16. Blocs imbriqués

> ### Attention
> - Point important
> - Point critique

17. Markdown étendu (selon moteur)

Selon l’outil :

  • admonitions
  • callouts
  • diagrammes
  • PlantUML intégré

Ces extensions sont hors standard Markdown pur.

PARTIE 3 — GLOSSAIRE / RÉFÉRENCE RAPIDE

Titres

# ## ### ####

Gras / Italique

**gras**
*italique*

Listes

- item
1. item

Liens

[texte](url)

Images

![alt](image)

Code

`inline`

```lang
code


## Tableaux
```md
| A | B |
|---|---|

Citation

> texte

Séparateur

---

Conclusion

Markdown est :

  • simple à apprendre
  • puissant à long terme
  • idéal comme socle documentaire

Il s’intègre naturellement avec :

  • UML (PlantUML)
  • Git
  • Wiki techniques
  • Documentation projet

👉 C’est un choix rationnel et durable.

No comments to display

Back to top