-
Notifications
You must be signed in to change notification settings - Fork 23
Add diagrams support using Kroki #1599
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
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🔍 Preview links for changed docs |
reakaleek
reviewed
Jul 22, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice.
Nit: can you add the diagram type to the LLM markdown output as type
attribute
In diagrams.md you can see that diagrams are rendered as
<diagram>
digraph G {
rankdir=LR;
A -> B -> C;
A -> C;
}
</diagram>
I think it would be nice if it was <diagram type="graphviz">
@reakaleek Added in 48d7319 — check it out! |
reakaleek
reviewed
Jul 22, 2025
reakaleek
approved these changes
Jul 22, 2025
Mpdreamz
approved these changes
Jul 22, 2025
This was referenced Jul 22, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds diagrams support for most docs-as-code diagram types using the Kroki universal API. This has the advantage that it doesn't add overhead to the docs site like MermaidJS does, nor lengthens the build process (it doesn't call a CLI tool like D2). The PR currently uses the free Kroki service, though we could easily self-host Kroki.
Supported formats
Accepts
mermaid
,d2
,graphviz
,plantuml
,ditaa
,erd
,excalidraw
,nomnoml
,pikchr
,structurizr
,svgbob
,vega
,vegalite
, andwavedrom
. Usesmermaid
by default.How it works
Usage example
Implementation details
DiagramBlock.cs
: Parses directive, extracts content and type, handles validation.DiagramEncoder.cs
: Handles zlib compression and base64url encoding for Kroki compatibility.DiagramViewModel.cs
andDiagramView.cshtml
: Render SVG images or error messages.DirectiveBlockParser.cs
andDirectiveHtmlRenderer.cs
: Integrated new directive into the parsing and rendering pipeline.DiagramTests.cs
: 16+ unit tests for all supported diagram types and error states.