4 points par GN⁺ 2023-07-01 | 1 commentaires | Partager sur WhatsApp
  • MdBook est un outil en ligne de commande qui permet de créer des livres avec Markdown.
  • Il est excellent pour créer de la documentation produit ou API, des tutoriels et des supports de cours.
  • MdBook utilise une syntaxe Markdown légère qui vous permet de vous concentrer sur le contenu.
  • Il prend aussi en charge la recherche intégrée et la coloration syntaxique pour des blocs de code dans plusieurs langages.
  • Vous pouvez personnaliser le format de sortie à l’aide de fichiers de thème.
  • Vous pouvez ajouter une syntaxe personnalisée et modifier le contenu à l’aide de préprocesseurs.
  • MdBook est écrit en Rust, ce qui le rend rapide, sûr et simple.
  • Il dispose de tests automatisés pour les exemples de code Rust.
  • MdBook est utilisé dans le projet du langage de programmation Rust et dans le livre The Rust Programming Language.
  • MdBook est gratuit et open source, et vous pouvez contribuer à son développement sur GitHub.
  • Le code source et la documentation de mdBook sont distribués sous Mozilla Public License v2.0.

1 commentaires

 
GN⁺ 2023-07-01
Avis Hacker News
  • L’utilisation de bibliothèques hébergées sur un CDN expose les utilisateurs de MdBook à des risques potentiels de panne serveur et de collecte de données.
  • La combinaison de Highlight.js et MathJax est inefficace et inutilement lourde dans le front-end de MdBook.
  • MdBook est un outil en ligne de commande pour créer des livres en Markdown.
  • Parmi les autres outils similaires mentionnés dans les commentaires figurent Jekyll, MkDocs, Hugo et Antora.
  • Certains utilisateurs trouvent MdBook trop minimaliste et l’ont étendu avec du code Rust personnalisé.
  • Gitbook a été populaire à une époque, mais il est devenu lent et certaines fonctionnalités ont été abandonnées.
  • Certains utilisateurs préfèrent MkDocs à MdBook pour ses fonctionnalités intégrées, comme une table des matières à droite.
  • MdBook est salué pour sa simplicité et sa rapidité à générer de petites pages statiques.
  • KeenWrite est mentionné comme un autre outil pour créer des livres basés sur Markdown à l’aide de ConTeXt.
  • Certains utilisateurs expriment leur mécontentement vis-à-vis de Markdown et cherchent des alternatives pour rédiger de la documentation technique.
  • Markdown est apprécié pour sa concision, et certains se demandent pourquoi il n’est pas utilisé par défaut pour les livres et la documentation.