Add mermaid diagram support to markdown

[j-h-a]

Description

It would be great to include mermaid support (flow charts, sequence diagrams, class diagrams, etc.) in markdown.

Reasons

Diagrams are useful in documentation.

Initial Research

It looks like asyncapi-react already uses markdown-it and this VS code extension demonstrates how easy it can be to add mermaid support to markdown-it containers.

[github-actions]

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️