theopensystemslab / fairhold-dashboard

https://fairhold-dashboard.vercel.app
0 stars 0 forks source link

Install a documentation library to generate diagrams of classes #121

Closed zz-hh-aa closed 23 hours ago

zz-hh-aa commented 1 week ago
Library Outputs
typedoc Outputs HTML documentation, reading JSDocs.
typedoc-plugin-mermaid Plugin for typedoc which outputs mermaid diagrams; they have to be manually drawn so probably not suitable for our purposes.
typedoc-umlclass Typedoc plugin, generates UML and inserts into the Typedoc HTML.
classdiagram-ts VSCode extension that outputs UML graphs that can be exported as an image, limited visual customisation.
TsUML2 Outputs SVG, nomnoml or mermaid.