mdBook : la compilation (build)
mdBook fonctionne sur un principe de compilation (build).
Le compilateur mdBook (mdBook builder) analyse et interprète les fichiers sources mdBook pour construire un site web mdBook.
Pour voir le résultat d’un travail d’écriture, il nous faut effectuer une compilation via la commande :
mdbook build
Nous lançons cette commande depuis un Terminal en étant dans le dossier nom-du-projet/.
mdBook utilise le fichier de paramètres book.toml, le fichier listant les fichiers à compiler SUMMARY.md, ainsi que les contenus du dossier source utilisés par les fichiers à compiler afin de créer l’ensemble des dossiers et fichiers permettant de servir le site web mdBook dans le dossier destination.
Le dossier source est le dossier nom-du-projet/src (par défaut).
Le dossier destination est le dossier nom-du-projet/book (par défaut).
Mise en garde importante
Le compilateur mdBook efface et recrée l’ensemble des fichiers et sous-dossiers destinations à chaque compilation.
Nous n’avons pas à intervenir dans le dossier nom-du-projet/book.
Si nous souhaitons ajouter des fichiers au site Web mdBook, nous le faisons dans le dossier source.
Voir les méthodes décrites dans :
Autres actions du compilateur
Le compilateur crée les sous-dossiers et fichiers.md définis dans SUMMARY.md et dans les pages mdBook s’ils n’existent pas.