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

Add support for Mermaid diagrams #94

Open
eriksjolund opened this issue May 10, 2023 · 0 comments
Open

Add support for Mermaid diagrams #94

eriksjolund opened this issue May 10, 2023 · 0 comments

Comments

@eriksjolund
Copy link

eriksjolund commented May 10, 2023

GitHub renders diagrams from Mermaid code that is included in Markdown (see GitHub docs).
For instance these lines

https://github.com/containers/podman/blob/287a4193e70301a63908ca8529eb10c39265ee24/docs/tutorials/socket_activation.md?plain=1#L20-L24

are rendered as

stateDiagram-v2
    [*] --> systemd: first client connects
    systemd --> podman: socket inherited via fork/exec
Loading

when viewed in the Podman socket activation tutorial located at GitHub
https://github.com/containers/podman/blob/main/docs/tutorials/socket_activation.md

The same Mermaid diagram is not rendered at the web page
https://podman.io/docs/tutorials/socket_activation
instead the Mermaid code is displayed.

I found a web page in the Docusaurus docs about Mermaid support
https://docusaurus.io/docs/markdown-features/diagrams

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant