Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mermaid support for rendering SVG #10497

Open
bsmth opened this issue Feb 12, 2024 · 0 comments
Open

Mermaid support for rendering SVG #10497

bsmth opened this issue Feb 12, 2024 · 0 comments
Labels
🌱 feature-request new feature request or enhancements to existing features idle involves: Content Requires the attention of the Content team. needs decision from engineering needs discussion

Comments

@bsmth
Copy link
Member

bsmth commented Feb 12, 2024

I'd like to create a tracking issue for Mermaid support as the best candidate for maintaining SVG diagrams. There are a number of discussions about this:

Discussions:

And as for some options, if we don't want to add more JS client side or do the rendering at build time as a Yari dependency, there is the option to generate SVG from mmd files in an automated way using the CLI (a CI job / script / automation in content repo on new .mmd files, for instance).

e.g.;

npm install -g @mermaid-js/mermaid-cli
mmdc -i input.mmd -o output.svg

In terms of optimizations, there is SVGO which also has a GUI.

Related issues:

Pull requests:

@bsmth bsmth added the 🌱 feature-request new feature request or enhancements to existing features label Feb 12, 2024
@github-actions github-actions bot added the needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. label Feb 12, 2024
@argl argl added needs decision from engineering needs decision from content lead needs discussion involves: Content Requires the attention of the Content team. and removed needs decision from content lead needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened. labels Feb 13, 2024
@github-actions github-actions bot added the idle label Mar 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌱 feature-request new feature request or enhancements to existing features idle involves: Content Requires the attention of the Content team. needs decision from engineering needs discussion
Projects
None yet
Development

No branches or pull requests

2 participants