Skip to content

Utiliser (?) les admonitions de MyST/JupyterBook

MyST étends la syntaxe de Markdown avec de nombreux éléments syntaxiques utiles pour des documents scientifiques:

  • environnements (admonitions) pour produire des encadrés, avec notamment des environnements dédiés pour exercices, solutions, etc.
  • références croisées par labels
  • bibliographie, ...

Avantages:

  • Joli
  • Syntaxiquement concis
  • Exprime la sémantique plutôt que la forme Inconvénient:
  • Un peu moins portable que tu Markdown pur.
  • Requiers l'utilisation d'une extension pour JupyterLab qui n'est pas encore disponible sous JupyterLite et qui est incompatible avec certaines constructions html.

À faire

Explorer l'utilisation de MyST dans ce tutoriel dans une branche myst.

  • Convertir les encadrés existants HTML en MyST
  • Utiliser des encadrés repliables pour donner des indications ou solutions
  • Utiliser des labels pour les références croisées plutôt que d'écrire en dur les noms de carnets?

/cc @souphiane.jender