DocumenterDiagrams.jl

June 26, 2023 ยท View on GitHub

Diagram features for Documenter.jl, powered by Kroki.jl

CI made in BR

Usage

In your make.jl file:

using Documenter
using DocumenterDiagrams

In your source .md:

```@diagram mermaid
graph LR
  D["@diagram block"]
  DJL["Documenter.jl"]
  KJL["Kroki.jl"]
  K["kroki.io"]
  SVG[".svg"]
  
  D --> DJL;
  DJL --> KJL;
  KJL --> K;
  K --> KJL;
  KJL --> DJL;
  DJL ---> SVG;
```

will render as:

graph LR
  D["@diagram block"]
  DJL["Documenter.jl"]
  KJL["Kroki.jl"]
  K["kroki.io"]
  SVG[".svg"]
  
  D --> DJL;
  DJL --> KJL;
  KJL --> K;
  K --> KJL;
  KJL --> DJL;
  DJL ---> SVG;