Add support for Mermaid diagrams rendering #461
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
Contributor
|
🚀 Preview is available at https://2354b4e7.enterprise-contract.pages.dev |
st3penta
force-pushed
the
add-mermaid-support
branch
from
1ba9db8 to
59098aa
Compare
simonbaird
approved these changes
Sep 2, 2025
antora/extensions/mermaid.js
Outdated
| } | ||
| } | ||
|
|
||
| module.exports = createMermaidExtension() No newline at end of file |
Member
There was a problem hiding this comment.
Nitpick about the final newline.
(Side-note: Claude told me that it respects an .editorconfig file which might be a permanent fix for this nit...)
This PR introduces the possibility to add mermaid diagrams directly as code in the antora docs. These diagrams are then rendered client-side in real time. They support zooming and panning, making them really easy to view and navigate. Support for mermaid will allow for easy integration of high level conforma diagrams into our docs, that are easily versionable (as opposed to embedding pre-rendered images generated by other tools) Assisted by: Claude Code Ref: https://issues.redhat.com/browse/EC-1270
st3penta
force-pushed
the
add-mermaid-support
branch
from
59098aa to
ac57ae1
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 introduces the possibility to add mermaid diagrams directly as code in the antora docs.
These diagrams are then rendered client-side in real time. They support zooming and panning, making them really easy to view and navigate.
Support for mermaid will allow for easy integration of high level conforma diagrams into our docs, that are easily versionable (as opposed to embedding pre-rendered images generated by other tools)
Assisted by: Claude Code
Ref: https://issues.redhat.com/browse/EC-1270