Aller au contenu

MdBook — Créer un livre interactif

MdBook est un outil en Rust pour créer des livres/documentations en ligne.

1) Installer Rust

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
# Répondre : 1 (Entrée)

Ajouter Rust au PATH dans ~/.bashrc :

export PATH=$PATH:~/.cargo/bin
source ~/.bashrc

2) Installer MdBook

cargo install mdbook
mdbook --version     # Vérifier l'installation

3) Créer un projet

mdbook init monlivre

Structure générée :

monlivre/
├── book.toml
└── src/
    ├── SUMMARY.md
    └── chapter_1.md

Ajoutez vos chapitres dans SUMMARY.md, puis construisez le livre :

mdbook build
mdbook serve    # Prévisualisation locale

MdBook, est donc un cousin « pur Rust » de Mkdocs et Zensical

  • MdBook est développé par l'équipe du langage Rust elle-même, qui l'utilise pour produire The Rust Programming Language, le manuel de référence du langage.

  • Contrairement à Zensical ou MkDocs Material, pensés pour une arborescence libre de pages, MdBook suit la logique d'un livre : un sommaire (SUMMARY.md) qui définit une progression linéaire de chapitres, et une configuration réduite à un seul fichier book.toml.

  • Même exigence de rigueur que ses cousins Rust : aucune tolérance pour un encodage fautif ou une référence orpheline.