mdBook : Suggestions d’améliorations et remarques

Suggestions d’amélioration

Créer un outil de création sans ruptures

Il faudrait permettre la création d’un plan de document unique et, ensuite, nous donner la possibilité de choisir le découpage du projet en sous-documents.

Créer un éditeur WYSIWYG

Il est évident que cela serait un plus de proposer un environnement de création graphique, visuel, qui permet de voir le rendu lors de la saisie et des opérations.

Cet outil pourrait être associé, tel à un EDI à :

• des touches d’action rapide ;
• une aide contextuelle.

Proposer la gestion de redirections

Si nous sommes amenés à modifier notre plan de chapitres et sous-chapitres ou simplement le nommage de fichiers, il serait intéressant de nous permettre de générer une liste de redirections de liens.

Si cela était envisagé ou fait, il faudrait réfléchir à faire en sorte que cela fonctionne avec les sous-chapitres (#titre-de-sous-chapitre).

Donner plus de liberté dans SUMMARY.md

Les usages proposés dans SUMMARY.md sont très limités, beaucoup trop à mon avis.

Il faudrait pouvoir :

• définir des sous-niveaux de rubriques de sommaire ;
• ajouter des zones « libres » (pour, par exemple, disposer un lien vers un site web)

Proposer des outils de génération automatique de certaines informations

Je pense que tout document devrait être associé à des informations clefs.

Dans le temps, on nous apprenait à réaliser des « cartouches » et à y apposer un certain nombre d’informations.

Ici par exemple :

• le nom du ou des auteurs,
• la date de création,
• la date de dernière mise à jour,
• l’outil utilisé pour la création,
• etc.

Ces informations pourraient être reportées :

• au niveau document ;
• au niveau d’une page.

Bien entendu, cette fonction devrait respecter quelques principe simples :

• permettre de l’activer ou non projet mdBook par projet mdBook ;
• permettre d’indiquer si nous souhaitons une politique globale pour tous, ou décider unitairement ;
• proposer les outils pour la gestion des informations affichées
  • globalement ;
  • page mdBook par page mdBook (si souhaité).

Remarques

Choix de Markdown

Il est dommage, je trouve, de s’appuyer sur Markdown : ce langage, comme beaucoup d’autres (BBcode par exemple) est très pauvre et fastidieux à utiliser.

Il manque d’évolutivité.

Par ailleurs, je crois qu’il vaut mieux limiter le nombre de langages de référence sauf, bien entendu, dans le cas où un saut technologique nécessite d’abandonner un précédent langage.

HTML est un langage qui, jusqu’à preuve du contraire, remplit parfaitement son rôle pour ce qui est de créer des supports pour le Web : nous devrions donc, tous ensemble, nous concentrer sur l’apprentissage, la maîtrise, la valorisation et l’amélioration continue de celui-ci.

Bien entendu, j’ai conscience que je dis cela dans un monde où l’écosystème Markdown s’est imposé et développé.

Je trouve moi-même Markdown « pratique » : il permet d’être fainéant·e et de faire vite. Mais je sais que cela finit par causer des dommages, dommages auxquels s’ajoutent ceux liés à l’absence de standard international unique et reconnu…