Livre de recettes simples⚓︎
QCM à cocher, solution en regard⚓︎
Par Franck CHAMBON
QCM à cocher
On souhaite proposer un QCM, auto corrigé.
Exemple 1
Pour cet exercice sur Python, on ne regarde que si l'identifiant est valide, il pourrait être mal choisi.
-
as
-
Roi
-
2ame
-
v413t
-
dix
-
n'œuf
-
huit
-
Sète
-
carte_six
-
_5
-
%4
-
quatre-moins-un
-
2!
-
_
- ❌
as
; c'est un mot réservé. - ✅
Roi
- ❌
2ame
; interdit de commencer par un chiffre. - ✅
v413t
- ✅
dix
- ❌
n'œuf
; interdit d'utiliser'
- ✅
huit
- ✅
Sète
- ✅
carte_six
- ✅
_5
- ❌
%4
; interdit d'utiliser%
- ❌
quatre-moins-un
; interdit d'utiliser-
- ❌
2!
; interdit d'utiliser!
- ✅
_
Méthode 1
- On utilise les cases à cocher avec l'option cliquable.
- On utilise des caractères Unicode pour les réponses, ❌ et ✅.
- On utilise les SuperFences
Dans mkdocs.yml
markdown_extensions:
- pymdownx.tabbed
- pymdownx.superfences
Dans le source
Pour cet exercice sur Python,
on ne regarde que **si l'identifiant est valide**,
il pourrait être mal choisi.
=== "Cocher les identifiants valides"
- [ ] `as`
- [ ] `Roi`
- [ ] `2ame`
- [ ] `v413t`
- [ ] `dix`
- [ ] `n'œuf`
- [ ] `huit`
- [ ] `Sète`
- [ ] `carte_six`
- [ ] `_5`
- [ ] `%4`
- [ ] `quatre-moins-un`
- [ ] `2!`
- [ ] `_`
=== "Solution"
- ❌ `as` ; c'est un mot réservé.
- ✅ `Roi`
- ❌ `2ame` ; interdit de commencer par un chiffre.
- ✅ `v413t`
- ✅ `dix`
- ❌ `n'œuf` ; interdit d'utiliser `'`
- ✅ `huit`
- ✅ `Sète`
- ✅ `carte_six`
- ✅ `_5`
- ✅ `_`
- ❌ `%4` ; interdit d'utiliser `%`
- ❌ `quatre-moins-un` ; interdit d'utiliser `-`
- ❌ `2!` ; interdit d'utiliser `!`
- ✅ `_`
Exemple 2
Cocher le meilleur identifiant pour une variable Python.
Propositions
-
pv
-
p_vie
-
points_vie
-
les_points_de_vie
Réponse
- ❌
pv
- ❌
p_vie
- ✅
points_vie
- ❌
les_points_de_vie
Méthode 2
- On utilise les cases à cocher avec l'option cliquable
- On utilise des caractères Unicode pour les réponses, ❌ et ✅
- On utilise les Admonitions
- Avec la possibilité
details
- Avec la possibilité
Dans mkdocs.yml
markdown_extensions:
- admonition
- pymdownx.details
Dans le source
!!! done "Exemple 2"
Cocher le meilleur identifiant pour une variable Python.
!!! faq "Propositions"
- [ ] `pv`
- [ ] `p_vie`
- [ ] `points_vie`
- [ ] `les_points_de_vie`
??? done "Réponse"
- ❌ `pv`
- ❌ `p_vie`
- ✅ `points_vie`
- ❌ `les_points_de_vie`
Exemples de coloration syntaxique⚓︎
Par Franck CHAMBON
Les mathématiques⚓︎
Colorer les maths
On peut colorer Python en ligne avec `#!python for i in range(10): print(i)`
- Ce qui donne
for i in range(10): print(i)
On souhaite pouvoir faire `#!math $\mathrm{e}^{\mathrm{i}\pi} + 1 = 0$`
- Mais le résultat
$\mathrm{e}^{\mathrm{i}\pi} + 1 = 0$
est non coloré... - De même en utilisant
`#!mardown $\mathrm{e}^{\mathrm{i}\pi} + 1 = 0$`
Exemple
On aimerait avoir $\mathrm{e}^{\mathrm{i}\pi} + 1 = 0$
Méthode
On utilise le lexer latex
à la place de math
.
Solution `#!latex $\mathrm{e}^{\mathrm{i}\pi} + 1 = 0$`
De même pour les maths en mode équation.
Les sessions de Terminal⚓︎
Colorer une session
Il existe le mot clé console
qui fonctionne différemment de bash
Exemple
Entrée
```console
$ python --version
Python 3.8.5
$ pip --version
pip 21.0.1 from .../lib/python3.8/site-packages/pip (python 3.8)
```
Rendu
$ python --version
Python 3.8.5
$ pip --version
pip 21.0.1 from .../lib/python3.8/site-packages/pip (python 3.8)
Entrée
```bash
$ python --version
Python 3.8.5
$ pip --version
pip 21.0.1 from .../lib/python3.8/site-packages/pip (python 3.8)
```
Rendu
$ python --version
Python 3.8.5
$ pip --version
pip 21.0.1 from .../lib/python3.8/site-packages/pip (python 3.8)
La commande et le résultat ne se détachent pas.
Des modifications à apporter⚓︎
Typos, ajouts, retrait
On souhaite indiquer une liste de modifications mineures.
Exemple
Entrée
```diff
-vous attend!
+vous attend !
-par un espace
+par une espace
-la fonction retourne
+la fonction renvoie
-Netiquette
+Nétiquette
```
Rendu
-vous attend!
+vous attend !
-par un espace
+par une espace
-la fonction retourne
+la fonction renvoie
-Netiquette
+Nétiquette
Entrée
```
-vous attend!
+vous attend !
-par un espace
+par une espace
-la fonction retourne
+la fonction renvoie
-Netiquette
+Nétiquette
```
Rendu
-vous attend!
+vous attend !
-par un espace
+par une espace
-la fonction retourne
+la fonction renvoie
-Netiquette
+Nétiquette
Image cliquable⚓︎
Rappels
- Un lien s'obtient avec
[<élément à cliquer>](<url>)
- Une image s'obtient avec
![<texte alternatif>](<source_image>)
Pour avoir une image cliquable
[![<texte alternatif>](<source_image>)](<url>)