Annexes - docs as code - générateur de site statique

[mborne]

Gérer la documentation en markdown

Apprendre la syntaxe

• www.markdownguide.org - Basic Syntax pour la syntaxe de base
• www.markdownguide.org - Extended Syntax pour la syntaxe avancée

Produire des tableaux

• www.tablesgenerator.com

Produire des schémas

Pour dessiner des schémas :

• draw.io (desktop) et www.diagrams.net (en ligne)
• GanttProject

Pour des schemas as code :

• Diagrams (diagrams.mingrammer.com) qui s'appuie sur Graphviz
• Mermaid
• www.websequencediagrams.com
• kroki.io

Produire le résultat en HTML

Il existe de nombreux générateurs de sites statiques :

• Jekyll qui est utilisé par défaut pour GitHub pages.
• MkDocs qui offre une recherche efficace pour peu de configuration.
• Docsify qui semble plus adapté pour la documentation d'un projet.
• github.com - Static Site Generators
• jamstack.org - Site Generators

Produire des présentations

• Marp (Markdown Presentation Ecosystem)
• ...