Aide-mémoire Markdown .md

420-SN1-RE - Écrire un beau README avec juste quelques symboles

« Je tape » = le texte que j'écris « Je vois » = le rendu affiché 🖨️ Ctrl + P pour imprimer

#Les titres

Je tape

# Titre principal ## Sous-titre ### Petit titre
▼

Je vois

Titre principal

Sous-titre

Petit titre

Le nombre de # donne la taille : un seul pour le grand titre. Un espace après les # est obligatoire.

** *Mettre en valeur

Je tape

Du texte en **gras**, en *italique*, et du `code`.
▼

Je vois

Du texte en gras, en italique, et du code.

** = gras, * = italique, l'accent grave ` = code en ligne (nom de variable, commande).

-Liste à puces

Je tape

- Première mesure - Deuxième mesure - Troisième mesure
▼

Je vois

  • Première mesure
  • Deuxième mesure
  • Troisième mesure

Un tiret puis un espace au début de chaque ligne. (Le * ou le + marchent aussi.)

1.Liste numérotée

Je tape

1. Ouvrir le calepin 2. Coller les données 3. Lancer le programme
▼

Je vois

  1. Ouvrir le calepin
  2. Coller les données
  3. Lancer le programme

Un chiffre, un point, un espace. Markdown renumérote tout seul (même si tu écris 1. 1. 1.).

- [x]Cases à cocher

Je tape

- [x] Code terminé - [ ] README écrit - [ ] Affichage testé
▼

Je vois

  • ✓Code terminé
  • README écrit
  • Affichage testé

Un x entre les crochets = coché ; un espace = à faire. Parfait pour une liste de tâches.

[ ]( )Les liens

Je tape

[Le cours](https://code.experimentations.xyz)
▼

Je vois

Entre crochets : le texte cliquable. Entre parenthèses : l'adresse complète.

![ ]( )Les images

Je tape

![Le volcan](volcan.png)
▼

Je vois

🌋Le volcan

Comme un lien, mais avec un ! devant. Le texte entre crochets décrit l'image (si elle ne charge pas).

>Citation / encadré

Je tape

> Astuce : teste ton code > sur un petit exemple d'abord.
▼

Je vois

Astuce : teste ton code sur un petit exemple d'abord.

Un > au début de la ligne crée un encadré, idéal pour une astuce ou une note.

``` ```Bloc de code

Je tape

```python moyenne = total / nombre print(moyenne) ```
▼

Je vois

moyenne = total / nombre
print(moyenne)

Trois accents graves ``` avant et après. Écris python après les premiers pour colorer le code.

---Ligne de séparation

Je tape

Fin d'une partie. --- Début d'une autre.
▼

Je vois

Fin d'une partie.


Début d'une autre.

Trois tirets --- seuls sur une ligne tracent un trait horizontal.

| |Les tableaux

Je tape

| Mesure | °C | |--------|----| | 1 | 411 | | 2 | 409 |
▼

Je vois

Mesure°C
1411
2409

Des | séparent les colonnes. La ligne de tirets sépare l'en-tête du contenu.

README.mdLe squelette d'un bon README

Je tape

# Mon programme ## À quoi il sert Résume des mesures et repère la valeur aberrante. ## Les ENTRÉES - La liste des mesures - Le seuil d'aberrance ## Les TRAITEMENTS - Calculer la moyenne - Calculer l'étendue - Détecter la valeur aberrante ## Les SORTIES - Affichage du rapport - Fichier resultats.txt

Je vois

Mon programme

À quoi il sert

Résume des mesures et repère la valeur aberrante.

Les ENTRÉES

  • La liste des mesures
  • Le seuil d'aberrance

Les TRAITEMENTS

  • Calculer la moyenne
  • Calculer l'étendue
  • Détecter la valeur aberrante

Les SORTIES

  • Affichage du rapport
  • Fichier resultats.txt

Le cadre du cours : à quoi ça sert, puis ENTRÉES → TRAITEMENTS → SORTIES. Un titre ## par partie, des puces dessous.