Support icons for mermaid architecture diagrams

[chambois]

Select Topic Area

Product Feedback

Body

Hi there!

Thanks for the mermaid support, it's great!

We're making use of mermaids architecture diagrams to plot some AWS infrastructure. Mermaid has support for icons but they don't yet render properly on Github (they just show up as blue boxes with a '?' symbol, which is a bummer - please see example below).

Please enable the rendering of the architecture icons for mermaid in Github, we'd greatly appreciate it!

With thanks,
Matt

---

Render from Github pages:

Render from VSCode with 'Markdown Preview Mermaid Support' extension:

[github-actions[bot]]

💬 Your Product Feedback Has Been Submitted 🎉

Thank you for taking the time to share your insights with us! Your feedback is invaluable as we build a better GitHub experience for all our users.

Here's what you can expect moving forward ⏩

• Your input will be carefully reviewed and cataloged by members of our product teams. 
  • Due to the high volume of submissions, we may not always be able to provide individual responses.
  • Rest assured, your feedback will help chart our course for product improvements.
• Other users may engage with your post, sharing their own perspectives or experiences. 
• GitHub staff may reach out for further clarification or insight. 
  • We may 'Answer' your discussion if there is a current solution, workaround, or roadmap/changelog post related to the feedback.

Where to look to see what's shipping 👀

• Read the Changelog for real-time updates on the latest GitHub features, enhancements, and calls for feedback.
• Explore our Product Roadmap, which details upcoming major releases and initiatives.

What you can do in the meantime 💻

• Upvote and comment on other user feedback Discussions that resonate with you.
• Add more information at any point! Useful details include: use cases, relevant labels, desired outcomes, and any accompanying screenshots.

As a member of the GitHub community, your participation is essential. While we can't promise that every suggestion will be implemented, we want to emphasize that your feedback is instrumental in guiding our decisions and priorities.

Thank you once again for your contribution to making GitHub even better! We're grateful for your ongoing support and collaboration in shaping the future of our platform. ⭐

[jesseadams]

Did this ever happen?

[vhbui02]

Nope

[juan-c-s]

did some of you find a workaround

[juan-c-s]

Fix: mermaid-cli has a feature to transform the markdown file with mermaid syntax to a new markdown file with the images of the diagrams.

Made the most sense to me since github does not render icons out-of-the-box

mmdc -i <input-md> -o <output-md> --iconPacks @iconify-json/logos @iconify-json/mdi

This script could be added to your pre-commit. Remember installing the cli

If someone finds a better workaround let us know