[FEATURE] Mermaid integration
@vogloblinsky is already working on this.
Since Jan 4, 2024.
- Dominant language
- TypeScript
- Stars
- 4.1k
- Forks
- 415
- PR merge metrics
- No merged PRs in 30d
Description
Overview of the feature
I would like to add mermaid diagrams to my documentation.
Motivation for or Use Case
Sometimes an images says more that a thousand words, that is why we would like to add mermaid diagrams to our documentation. Currently mermaid is not support by Compodoc while I think it is a nice feature a lot of people would benefit from.
Related issues
This feature is requested before in https://github.com/compodoc/compodoc/issues/600 and https://github.com/compodoc/compodoc/pull/1278 and @matteopini-horsa even showed how this could be implemented with a few lines of code (https://github.com/compodoc/compodoc/pull/1278/files). This example shows that is a small change which shouldn't break any features.
If there is any more work that needs to be done to merge this feature please let me know, I'm happy to do this work since we really love Compodoc!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.