2

Example: README.md

# Objective
How can Doxygen generate content that includes Mermaid diagrams embedded in GitHub markdown files (*.md)?

# Mermaid Diagram
```mermaid
sequenceDiagram
    Alice->>John: Hello John, how are you?
    John-->>Alice: Great!
    Alice-)John: See you later!
```

# PlantUML Diagram
PlantUml works well with Doxygen.  Thank you!

```plantuml
@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response

Alice -> Bob: Another authentication Request
Alice <-- Bob: Another authentication Response
@enduml
```

The goal is to NOT have to create standalone Mermaid diagram files (*.mdd) and reference from a markdown document.

The goal is to use Mermaid like PlantUml can be used with Doxygen. PlantUml works great with Doxygen. However, Mermaid has an advantage that it is rendered in browser when a markdown document is viewed in GitLab, Azure DevOps Wiki and VS Code markdown preview.

Azure DevOps git is not supported unfortunately] (Vote here).

Mermaid has a disadvantage compared to PlantUml since diagrams are not created from markdown files included in Doxygen.

I expect this may be a challenging since Mermaid uses browser side rendering.

Thank in advance for any tips on using Mermaid with Doxygen.

Ed of the Mountain
  • 5,219
  • 4
  • 46
  • 54

0 Answers0