Leçon 6 / 6
Leçon 06 · Partie 2 — Aller plus loin

Markdown en pratique

Un README GitHub

Le fichier README.md est la carte de visite d'un projet GitHub. Il s'affiche automatiquement sur la page du dépôt.

Structure type d'un bon README :

# Nom du projet

Courte description en une ou deux phrases.

## Installation

```bash
git clone https://github.com/monuser/monprojet.git
cd monprojet
npm install
```

## Utilisation

```bash
npm start
```

Ouvre [http://localhost:3000](http://localhost:3000) dans ton navigateur.

## Fonctionnalités

- Authentification utilisateur
- Tableau de bord interactif
- Export PDF

## Contribuer

Les contributions sont les bienvenues. Ouvre une *issue* ou une *pull request*.

## Licence

MIT — voir le fichier [LICENSE](LICENSE).
💡

GitHub affiche les badges (build, version, licence) en haut du README. Ils utilisent la syntaxe image Markdown : ![badge](url-image)

Notes Obsidian et Notion

Obsidian stocke tout en fichiers .md. Notion comprend le Markdown dans ses blocs.

Un exemple de note de réunion :

# Réunion projet site — 15 avril 2026

**Présents :** Marie, Paul, Sophie

## Décisions

1. Lancement prévu le 1er mai
2. Design validé par le client
3. Sophie prend en charge le SEO

## Points en suspens

- [ ] Vérifier la compatibilité mobile
- [ ] Rédiger les CGU
- [ ] Tester le formulaire de contact

## Prochaine réunion

> Vendredi 22 avril à 10h — salle de conf B
💡

La syntaxe - [ ] crée une case à cocher (checkbox). - [x] la coche. Ça fonctionne sur GitHub, Obsidian et GitLab.

Messages Discord

Discord supporte un sous-ensemble de Markdown dans ses messages.

B

Gras

**texte** → texte

fonctionne
i

Italique

*texte* → texte

fonctionne
S

Barré

~~texte~~ → texte

fonctionne
</>

Code inline

`code` → code

fonctionne
📦

Bloc de code

Trois backticks + langage

fonctionne
>

Citation

> texte → bloc cité

fonctionne
⚠️

Discord ne supporte pas les tableaux ni les images en syntaxe Markdown (![alt](url) ne fonctionne pas — colle l'URL directement).

Usage professionnel

Markdown s'intègre dans de nombreux contextes pro :

  • Documentation technique — wikis, guides, API docs (Notion, Confluence, Docusaurus)
  • Rédaction collaborative — GitHub issues, pull requests, reviews de code
  • Journaux de bord — changelogs, CHANGELOG.md versionné avec le code
  • Emails techniques — certains clients mail affichent le Markdown (Superhuman, HEY)
  • Présentations — Marp, Slides.com et Reveal.js génèrent des slides depuis du Markdown
  • Sites statiques — Hugo, Jekyll, Eleventy, Gatsby utilisent des fichiers Markdown

Exemple — CHANGELOG.md

# Changelog

## [2.1.0] — 2026-04-15

### Ajouté
- Nouvelle page profil utilisateur
- Export en format CSV

### Modifié
- Temps de chargement réduit de 40%

### Corrigé
- Bug d'affichage sur mobile Safari

## [2.0.0] — 2026-03-01

### Ajouté
- Refonte complète de l'interface
- Mode sombre
💡

Le format Keep a Changelog (keepachangelog.com) est un standard reconnu pour structurer un CHANGELOG.md.

// À retenir
  • README.md = carte de visite GitHub — titre, install, usage, licence
  • Obsidian = tout en .md — cases à cocher avec - [ ]
  • Discord = gras, italique, code, citations OK — pas de tableaux
  • Professionnel = docs, wikis, changelogs, slides, sites statiques
  • Markdown s'apprend une fois et s'utilise partout
  • Fichier .md = texte brut pérenne, lisible sans outil