containers / containers/podman.io

Add support for Mermaid diagrams

Open
#94 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
108
Forks
188
Avg merge
9d 15h
Merged PRs (30d)
11

Description

GitHub renders diagrams from Mermaid code that is included in Markdown (see [GitHub docs](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams)).
For instance these lines

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

are rendered as

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

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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.