Details
-
Task
-
Resolution: Unresolved
-
P3: Somewhat important
-
None
-
5.13.0, 5.14.0 RC1
-
None
Description
So I'm starting to integrate mermaid into my gitlab readmeas and wondering if we could have the same functionallity with qdocs. It is pretty easy actually, just enbedd their js library into your config.qdocconfig and follow their syntax inside your comment for qdocs:
/*! The class does the following: \raw HTML <div class="mermaid"> graph TD A[Client] --> B[Load Balancer] B --> C[Server01] B --> D[Server02] </div> \endraw */
We can than add the mermaid js library into our (Via CDN for easier demonstration) config.qdocconf
HTML.footer += "<script src=\"https://cdn.jsdelivr.net/npm/mermaid@8.4.0/dist/mermaid.min.js\"></script>"
The problem is that in the docs it states that one should avoid raw. I think this would be a really nice and fast to integrate feature
Attachments
Issue Links
- relates to
-
QTBUG-83799 qdoc: Add support for class diagrams
- Open