[feature]: Support for MermaidJs diagrams
@srinivaspendem is already working on this.
Since Mar 27, 2024.
- Dominant language
- TypeScript
- Stars
- 59.6k
- Forks
- 5.8k
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 49
Description
Is there an existing issue for this?
- I have searched the existing issues
Summary
It would be great if Pages and Issues could support MermaidJs diagrams in their main content areas.
As far as I know it's simply a case of including their JS file, and it can also be lazy loaded so it does not impact users not using the feature.
Why should this be worked on?
This would allow diagrams as code to be easily inserted into Pages or Issues. Diagrams as code would save on disk space used by the image based equivalent, and are much more suitable for tracking in version control etc.
Mermaid seems to be one of the mainstream accepted formats. Gitlab and Github support Mermaid diagrams.
If Mermaid is a no-go, then PlantUML is also a good option but it requires a Java program to render the diagrams, whereas Mermaid is pure JavaScript.
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.