Vous rêvez de créer votre propre livre électronique ou une bonne grosse documentation technique mais vous ne savez pas par où commencer ?

Ne cherchez plus, mdBook est là pour vous !

Il s’agit d’un outil codé en Rust, qui a l’aide de quelques commandes simples, vous permettra d’initialiser la structure de votre ouvrage, de rédiger votre contenu en Markdown, de personnaliser le rendu et de le mettre en ligne. Voici un exemple de ce que ça peut donner comme rendu.

Pour démarrer votre aventure avec mdBook, rien de plus simple. Installez l’outil en suivant les instructions sur le site officiel, puis lancez la commande suivante dans un terminal :

mdbook init mon-premier-livre

Et voilà, le squelette de votre chef-d’œuvre est prêt et vous n’avez plus qu’à rédiger !

mdBook regorge de fonctionnalités pour mettre en forme votre contenu. Vous pouvez organiser vos chapitres dans le fichier SUMMARY.md, ajouter une page d’introduction dans README.md, créer votre propre template, et même inclure des images et autres ressources. Et une fois votre prose finalisée, vous pourrez donner vie à votre livre à l’aide de la commande :

mdbook serve

Celui-ci va alors générer une version web interactive accessible via un serveur web, avec une navigation et moteur de recherche intégré, de vos écrits. Et la commande

mdbook build

… vous permettra de générer une version HTML de votre bouquin.

Je trouve ça très satisfaisant de passer par le markdown pour la rédaction et la mise en forme. Je le faisais pour des prez style Powerpoint mais full markdown à l’époque où je faisais des confs, et c’était un vrai gain de temps.

Mais le véritable atout de mdBook, c’est sa capacité à automatiser la publication de votre livre. Grâce à l’intégration continue, chaque modification que vous apportez peut être instantanément mise en ligne. Comme ça, fini les mises à jour manuelles bien reloues !

Bref, vous l’aurez compris, mdBook est un excellent outil pour les auteurs qui aiment partager leur travail avec leur communauté. Ah, j’allais oublier ! Si vous avez besoin d’inspiration, n’hésitez pas à explorer la documentation officielle de mdBook. Vous y trouverez des astuces, des exemples et même des témoignages d’auteurs conquis.

Vous cherchez une solution simple pour présenter votre contenu en ligne ? Ne cherchez plus, Docsify-This est là pour vous faciliter la vie et le plus cool, c’est que ça utilise de simples fichiers textes au format markdown !

Docsify-This est surtout gratuit, open-source et capable de transformer vos fichiers Markdown en pages web modernes et attractives en 1 click. Plus besoin de vous prendre la tête avec de la configuration et du bricolage de code, avec Docsify-This, vous obtiendez directement un résultat sympa.

Docsify-This va analyser la structure de vos fichiers Markdown et générer automatiquement un site web au design plutôt épuré et au rendu assez pro. Comme ça, votre contenu sera mis en valeur avec une navigation intuitive, une recherche intégrée et même un mode nuit pour les accros du code qui travaillent jusqu’à pas d’heure. Voici un exemple de rendu tout fait :

Docsify-This offre une multitude de fonctionnalités pour personnaliser votre site selon vos envies, à savoir des thèmes tout faits, la possibilité d’ajouter votre propre logo, vos favicons, d’intégrer des images et des vidéos pour enrichir votre contenu, et bien plus encore.

Le site web de Docsify est cool pour tester l’outil avec son convertisseur en ligne, mais vous pouvez surtout l’héberger sur GitHub Pages, Vercel ou Netlify, sans débourser un centime, ou sur votre propre serveur si vous le souhaitez.

Voici d’ailleurs quelques exemples de workflow pour vous montrer les possibilités d’intégration avec Github ou en direct sur votre serveur.

Si ça vous intéresse de creuser ce truc, c’est sur le site de Docsify-This.