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.

mdBook : Atouts et limites

mdBook présente des avantages et des inconvénients, des atouts et des limites.

Je vous propose de vous donner mon analyse ici.

Une utilisation fastidieuse

Un éditeur est plus pratique

Le problème de l'approche en mode compilation d'un document, ou d'un site Web est que cela est plus fastidieux et pénible à la longue qu'une simple édition surtout s'il s'agit d'une édition WYSIWYG, en voyant directement le résultat de notre travail comme dans Wordpress ou MédiaWiki par exemple.

Il manque des outils à valeur ajoutée comme la correction orthographique et grammaticale

Par ailleurs, l'absence d'un éditeur riche nous prive de la correction orthographique et grammaticale que nous avons avec des outils de type CMS : comme nous les utilisons dans le navigateur Web, nous pouvons nous servir d'extensions pour nous aider à repérer nos fautes dans le texte.

L'absence de continuité et de « mode plan » est très pénalisante

Par exemple, si nous modifions le titre d'un chapitre dans SUMMARY.md, il faut penser à :

• renommer le fichier md correspondant à la fois dans le lien entre parenthèses ET
• modifier le titre qui s'affiche en haut du fichier .md correspondant.

Il peut exister des versions décalées

Du fait du fonctionnement du système, nous sommes comme dans le cadre d'un programme en développement.

De ce fait, l'auteur ou les auteurs d'un projet mdBook peuvent être en train de travailler sur la prochaine version alors qu'elle n'est pas encore chargée sur le site de production.

C'est assez habituel dans le monde du développement.

Ça l'est moins pour des béotiens qui peuvent être perturbés par cela.

Quels avantages ?

Mais alors, quels sont les avantages de ce produit ?

Utiliser mdBook, c'est intégrer la logique de la communauté Rust et espérer (savoir) que l'outil sera enrichi à l'avenir.

Utiliser mdBook, c'est bénéficier de cette logique de site compilé (« buildé ») et donc plus performant et plus sûr.

Utiliser mdBook, c'est bénéficier de l'outil de compilation et d'exécution de codes Rust intégrés.

« Pourquoi c'est faire ? »

Une des questions que je pose toujours est : « Pourquoi les développeurs ont-ils décidé de le produire alors même qu'il existait, au moment où ils ont fait ce choix, de nombreux outils capables de produire de la documentation de qualité ? »

Je n'ai franchement pas la réponse à cette interrogation à ce jour.

Et vous, qu'en pensez-vous ?

Parlons-en dans cette discussion : https://happynumeric.fr/phpbb/viewtopic.php?t=101.

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 : 16 mars 2023

Dernière mise à jour : 20 mars 2023 19:10