Ce bloc-notes mdBook vous est proposé avec passion par Marc JESTIN — Happy Numeric.
À votre service pour vous accompagner dans vos projets numériques.
Contact : https://happynumeric.fr/me-contacter.

Terminologie

J'utilise l'association avec mdBook de manière systématique pour éviter toute confusion.

Les expressions des concepts principaux sont toujours formulées de la même manière pour les mêmes raisons.

Je suppose que nous avons déjà procédé à l'installation de mdBook sur notre ordinateur pour ce qui suit.

Projet mdBook

Un projet mdBook est composé de plusieurs éléments et se construit au travers de ces quelques étapes :

• la création d'un dossier Nom-du-projet/ ;
• l'initialisation du projet mdBook dans ce dossier ;
• l'édition d'un fichier de paramètres de compilation mdBook book.toml (si nécessaire) ;
• l'édition d'un fichier SUMMARY.md qui construit le sommaire mdBook ;
• l'édition et le chargement d'un certain nombre de fichiers sources dans un dossier source ;
• la compilation par le compilateur mdBook ;
• la publication du site Web mdBook ainsi produit dans le dossier destination.

sommaire mdBook et fichier SUMMARY.md

Un site Web mdBook se présente comme un tout composé :

• d'un sommaire mdBook et
• de pages mdBook indiquées dans ce sommaire mdBook.

Le sommaire mdBook est le contenu qui apparaît à gauche des pages Web d'un document mdBook (par défaut).

Le sommaire mdBook donne accès aux différentes pages mdBook qui décrivent le contenu du projet mdBook : textes, images, liens, blocs de citation, blocs de codes, etc.

Le fichier du sommaire mdBook est le fichier SUMMARY.md (par défaut).

SUMMARY.md se trouve dans le dossier source Nom-du-projet/src (par défaut).

SUMMARY.md est interprété et géré différemment des autres fichiers par le compilateur mdBook.

Il ne faut pas renommer le fichier SUMMARY.md ni le déplacer du dossier source.

Pages mdBook et fichiers.md

Une page mdBook est reliée pas un lien interne au sommaire mdBook en tant que chapitre du sommaire mdBook.

Une page mdBook est un composant du site Web mdBook défini dans un fichier fichier.md écrit en langage Markdown.

Le nom des fichiers.md se termine par .md, md faisant référence à MarkDown.

Les fichiers.md peuvent être stockés dans des sous-dossiers du dossier source tout comme d'autres types de fichiers (images, codes informatiques, etc.).

Organisation du sommaire mdBook

Rubrique du sommaire mdBook

Une rubrique du sommaire mdBook est un titre non numéroté qui permet de compartimenter les chapitres pour en faciliter la lecture.

Une rubique du sommaire mdBook n'est pas associée à une page mdBook : elle ne comporte pas de lien.

Exemples de rubriques du sommaire mdBook :

• « Notions de base mdBook »
• « Structurer le sommaire mdBook »

Chapitre du sommaire mdBook

Un chapitre du sommaire mdBook est un titre numéroté ou non dans le sommaire mdBook.

Un chapitre du sommaire mdBook conduit en principe vers une page mdBook associée.

Exemple de chapitres du sommaire mdBook non numérotés ici :

• « Présentation » ;

Exemples de chapitres du sommaire mdBook numérotés ici :

• « mdBook : Concepts et organisation » ;
• « mdBook : SUMMARY.md : structurer les pages mdBook ».

Chapitre du sommaire mdBook sans page mdBook associée

Il est possible de ne pas associer de page mdBook à un chapitre du sommaire mdBook, numéroté ou non.

Exemples de chapitres du sommaire mdBook sans page mdBook associée ici :

• « mdBook : Mise en forme Markdown » ;
• « mdBook : Les liens ».

Sous-chapitre du sommaire mdBook

Les chapitres du sommaire mdBook peuvent comporter plusieurs niveaux.

Exemples de sous-chapitres du sommaire mdBook ici :

• « mdBook : La compilation » ;
• « mdBook : Markdown : Les images ».

Ces deux exemples sont des sous-chapitres du sommaire mdBook de niveau 2.

Chapitre de page mdBook

Un chapitre de page mdBook ou sous-chapitre de page mdBook est un ensemble indentifié par un titre suivi d'un contenu à l'intérieur d'une page mdBook.

Titre

Nous parlons de titre dans ce document pour parler indifféremment des titres de :

• rubriques du sommaire mdBook ;
• chapitres du sommaire mdBook ;
• chapitres de page mdBook.

Le plan du projet mdBook est constituée par l'ensemble de ces titres (voir Table des matières ci-dessous).

Table des matières

Bien que la documentation officielle et les infobulles des sites Web mdBook parlent de « Table of Contents », j'évite le terme table des matières.

En effet, le sommaire mdBook ne contient pas tous les titres et sous-titres d'un document mdBook. Les sous-niveaux définis dans les pages mdBook n'y figurent pas.

Il n'existe pas de Table des matières complète à proprement parler dans un site Web mdBook.

N'hésitez pas à me faire votre feedback, me signaler des erreurs ou des compléments que vous souhaiteriez que j'ajoute à ce bloc-notes mdBook.
Cliquez ici pour me contacter

À propos de cette page

Création : 15 mars 2023

Dernière version : 23 mars 2023 23:36