Introduction

Version : 0.5.4

mdBook est un outil en ligne de commande conçu pour créer des livres sites web et éventuellement des recueils mono-fichier à partir de fichiers Markdown. Il est idéal conçu pour concevoir des documentations de produits ou d’API, des tutoriels, des supports de cours ou tout autre projet nécessitant une présentation propre, facile à naviguer et personnalisable structurée telle que l’ont imaginée les concepteurs·trices de mdBook.

Points forts

• La syntaxe Markdown légère permet de rester pleinement concentré sur la rédaction de notre contenu d’utiliser un langage très utilisé et facilement portable.
• Le site web propose un moteur de recherche intégré.
• La coloration syntaxique prend en charge des blocs de code dans de nombreux langages.
• Les thèmes personnalisables permettent d’ajuster l’apparence et la mise en forme du rendu.
• Il est possible d’intégrer des préprocesseurs (preprocessors) pour étendre la syntaxe et pour modifier le contenu à la volée.
• Des moteurs de rendu (backends) peuvent générer le contenu final sous différents formats.
• mdBook est développé avec Rust ce qui lui permet d’être très performant, sûr et facile d’utilisation.
• mdBook permet l’utilisation d’outils de l’espace de jeu (playground) Rust pour compiler et / ou exécuter des échantillons de code Rust directement dans le site web produit.

La Documentation officielle mdBook et ce livre sont eux-même des exemples de ce qu’il est possible de produire avec mdBook.

mdBook est largement utilisé dans la communauté du langage Rust. On le retrouve par exemple comme moteur du site de référence du « (Rust) Book », The Rust Programming Language.

Contribuer

mdBook est un projet libre (free) à code ouvert (open source). ¹ Vous pouvez accéder à son code source sur GitHub ² ; les rapports d’anomalies et les demandes de fonctionnalités peuvent être soumis directement via le gestionnaire de tickets (Issue Tracker).

Le projet évolue grâce à l’implication de sa communauté pour corriger les bogues et ajouter de nouvelles fonctionnalités. Si vous souhaitez apporter votre contribution, nous vous invitons à consulter le guide du contributeur (CONTRIBUTING) et à soumettre une proposition de modification du code source (pull request).

Licence

Le code source ainsi que la documentation officielle de mdBook sont mis à disposition et publiés sous la licence Mozilla Public License v2.0. ³

1. Ils·elles ne semblent pas avoir entendu parler de la nuance importante associée au mot libre dans FLOSS (Free Libre Open Source Software), ou préférer ne pas s’en soucier… Pour mémoire : https://www.gnu.org/philosophy/free-sw.html. ↩

2. Github s’est vendue à Microsoft il y a déjà bien longtemps (2018). La communauté Rust semble peu encline à utiliser des supports plus libres voire autonomes. Dommage… ↩

3. Pour les personnes qui ne le savent pas, le langage de développement Rust a d’abord été développé par des collaborateurs·trices de Mozilla. mdBook est apparu tardivement dans le projet mais est clairement un sous-produit du développement du langage Rust. le premier commit sur le dépôt officiel de mdBook a été effectué le 6 juillet 2015, alors que la première version stable de Rust est sortie en mai de la même année. ↩