La documentation¶
Rédiger la documentation en Markdown¶
- www.markdownguide.org - Basic Syntax
- www.markdownguide.org - Extended Syntax
- tablesgenerator.com - markdown_tables pour produire des tableaux.
Contrôler les liens¶
En construction
Recherche d'outil en cours pour vérifier rapidement les liens dans une documentation markdown.
npx -y markdown-link-check ./docs/outils
Dessiner des schémas¶
- draw.io (desktop) et www.diagrams.net (en ligne)
Astuce
Inclure une copie du diagramme en exportant en PNG (.drawio.png) permet d'avoir des images éditables!
- DIA et StarUML (payant) sont particulièrement efficaces pour les diagrammes UML.
- GanttProject se focalise sur les diagrammes de Gantt
Générer des schémas¶
Pour des schemas as code :
- Mermaid offre une syntaxe pour différents types de schéma (Mindmap, diagramme de classe UML, diagramme de Gantt,...).
- www.websequencediagrams.com se spécialise sur les diagrammes de séquences.
Générer un site web¶
En construction
Ce site utilise mkdocs-material mais mkdocs 2.0 amène la création de zensical par les créateurs de mkdocs-material -> je dois refaire le tour des solutions disponibles en 2026.
Il existe de nombreux générateurs de sites statiques :
- Jekyll qui est utilisé par défaut pour GitHub pages.
- MkDocs
- Docsify
- github.com - Static Site Generators
- jamstack.org - Site Generators
Produire des présentations¶
Il est aussi possible de générer des slides en HTML :