Explications paramètres YAML

Author: eyssette

README.md

@@ -3,6 +3,30 @@
 Un outil pour créer facilement un calendrier de l'avent en ligne
 
 1. Créez un fichier sur CodiMD ou sur une forge.
-2. Ce fichier doit comporter : un titre, un bloc de citation qui constituera le message initial, ainsi que pour chaque jour un titre, au moins une image et du contenu qui s'affichera quand on clique dessus. Vous pouvez récupérer [ce modèle](https://codimd.apps.education.fr/-PbI3GizQo6xV-TEiU1-sA?both). 
+2. Ce fichier doit comporter : un titre, un bloc de citation qui constituera le message initial, ainsi que pour chaque jour un titre, au moins une image et du contenu qui s'affichera quand on clique dessus. Vous pouvez récupérer [ce modèle](https://codimd.apps.education.fr/-PbI3GizQo6xV-TEiU1-sA?both).
 3. Votre calendrier de l'avent sera alors disponible à l'adresse : https://eyssette.forge.apps.education.fr/calendrier-avent#URL (en remplaçant URL par l'URL de votre fichier).
-4. Il est possible de cacher l'URL de votre fichier avec : https://eyssette.forge.apps.education.fr/calendrier-avent?c=1#URL (l'URL doit être encodée avec base64)
+4. Il est possible de cacher l'URL de votre fichier avec : https://eyssette.forge.apps.education.fr/calendrier-avent?c=1#URL (l'URL doit être encodée avec base64)
+
+## Paramètres
+
+On peut utiliser un en-tête YAML pour spécifier certains paramètres.
+
+```yaml
+---
+maths: false
+random: false
+bouncingEffect: true
+reveal: false
+revealAfter: 31/12/2024
+style:
+---
+```
+
+**Explications**
+
+- _maths_ : pour ajouter la gestion des mathématiques en Latex
+- _random_ : pour afficher les jours de manière aléatoire plutôt que dans l'ordre chronologique
+- _bouncingEffet_ : pour activer/désactiver l'effet de rebondissement de la case correspondant au jour actuel
+- _reveal_ : pour pouvoir voir le résultat quand tout est affiché
+- _revealAfter_ : pour indiquer une date à partir de laquelle tout le calendrier restera affiché en entier
+- _style_ : pour personnaliser l'apparence de son calendrier en CSS