Utilisation des “includes”

Pour des cours d’informatique, nous avons souvent besoin d’inclure des extraits de code ou de fichiers de configuration. On peut bien sûr écrire le contenu de ces fichiers directement dans le document markdown, mais c’est souvent plus simple d’utiliser un mécanisme permettant d’inclure le contenu d’un fichier en mentionnant juste le nom de ce fichier.

Pour inclure le contenu de fichier, le plus simple c’est d’utiliser le include markdown plugin pour MkDocs.

Ajoutez le module python du plugin dans votre configuration de mkdocs:

Allez à la racine de votre projet et tapez la commande suivante

poetry add mkdocs_include_markdown_plugin

Ajoutez aussi le plugin dans le fichier mkdocs.yml :

mkdocs.yml

plugins:
  include-markdown:
    opening_tag: '{!'
    closing_tag: '!}'

La documentation du plugin vous expliquera comment l’utiliser.