Mermaid support
nuvacore opened this issue · comments
Initial checklist
- I read the support docs
- I read the contributing guide
- I agree to follow the code of conduct
- I searched issues and couldn’t find anything (or linked relevant results below)
Problem
Github supports Mermaid, gfm does not.
Solution
Can you add support for Mermaid?
Alternatives
?
Github supports Mermaid, gfm does not.
That is the crux of the problem.
GitHub.com and GFM (both by GitHub) are different, and have been diverging for a while.
GFM the standard maintained by GitHub does not include Mermaid.
https://github.github.com/gfm/
https://github.com/orgs/remarkjs/discussions/932
Has some discussion on offering some mermaid support through a separate plugin.
And some candidates that you could try today
In addition to @ChristianMurphy's comment, I'd like to add that remark-gfm adds support for syntax. Mermaid support is different, it needs to transform the AST.
Also Mermaid doesn't work in Node.js. If remark-gfm added support, it would require some heavy dependencies like Mermaid and Puppeteer.
This is out of scope for this package. This package focusses on GFM. Which is the parsing side in markdown. Supporting mermaid is something that GH does which is not part of GFM. And is solved in the HTML postprocessing stages.
Hi! This was closed. Team: If this was fixed, please add phase/solved. Otherwise, please add one of the no/* labels.