Replies: 6 comments 5 replies
-
|
For now, as I workaround, my filter script performs a Base64 encoding of the Mermaid.js code. Something like: <script>
// To prevent Doxygen from messing up the formatting of the Mermaid.js input,
// we use a Base64 encoded version of the input in the pre.mermaid-b64.
// Before calling mermaid.initialize(), we decode the content of all pre.mermaid-b64 elements
// and change the class to pre.mermaid.
document.querySelectorAll('pre.mermaid-b64').forEach((element) => {
const decoded = atob(element.textContent);
element.textContent = decoded;
element.classList.remove('mermaid-b64');
element.classList.add('mermaid');
});
mermaid.initialize({
startOnLoad: true,
theme: 'base',
});
</script>Of course, if I could just tell Doxygen to not bother with linking in the mermaid |
Beta Was this translation helpful? Give feedback.
-
|
There are no commands, to my knowledge, that would accomplish this. This would lead to that e.g. should be rendered as Probably still not the easiest way but no extra software is needed. |
Beta Was this translation helpful? Give feedback.
-
|
Code has been integrated in master on GitHub. |
Beta Was this translation helpful? Give feedback.
-
|
@itavero Would you be willing to share your script? I have struggling with the same issue. And I don't think the special comment to doxygen above would be best way to go. I'm also using a script based on the script from tahyx that you linked in your initial post. In particular, how does your "filter script performs a Base64 encoding of the Mermaid.js code"? |
Beta Was this translation helpful? Give feedback.
-
|
Beta Was this translation helpful? Give feedback.
-
|
No, I didn't try. I may be misunderstanding the feature, but I don't think it will solve the issue. As stated the content of the special HTML comment will get ignored by regular Markdown processors but Doxygen will see it. But my issue (and I believe @itavero as well) is different. We have a markdown file that contains a mermaid diagram. For example: When viewing this markdown file in GitHub or an IDE (e.g. VS Code), the diagram is automatically rendered. But to ensure it is rendered correctly in HTML pages generated by Doxygen, some extra steps are needed. AFAIK there is no native support for Mermaid diagrams (yet) in Doxygen, like for PlantUML. So I use the script from tahyx to preprocess the markdown file in Doxygen using the The problem is that Doxygen will recognise the classnames and try to autolinks text, resulting in: This now contains illegal syntax that cannot be rendered by the Mermaid renderers. So I don't think the special HTML comment will work in this case, at least not in a easy-to-use way. Ideally, we could locally disable the autolinking or have native Mermaid support (that would effectively do the same). But in the short term I'd like to understand @itavero solution and solve the problem I'm having now. |
Beta Was this translation helpful? Give feedback.
-
|
Indeed there is no support for Mermaid diagrams, to be able to do it an approach similar to plantuml could be used but this at least requires some easy to use, free, well maintained Mermaid renderer software. When at least these preconditions are satisfied someone still has to implement it ... |
Beta Was this translation helpful? Give feedback.
-
|
I was planning to file a ticket with a request for Mermaid support if there isn't one yet already (didn't check yet). And potentially work on a PR. But I currently do not have the bandwidth to do so. Just FYI the Mermaid renderer is well maintained: https://github.com/mermaid-js/mermaid. But it's a little different from for example PlantUML, because for HTLM at least it renders the diagrams dynamically using JavaScript: https://mermaid.js.org/intro/#deploying-mermaid. For PDF this would require a different approach. There is a CLI version as well that may serve this purpose: https://github.com/mermaid-js/mermaid-cli. |
Beta Was this translation helpful? Give feedback.
-
|
There is an issue related to this #11445 |
Beta Was this translation helpful? Give feedback.
-
|
The CLI version of Mermaid is able to do that. See: Transform a markdown file with mermaid diagrams. But I have not given it much thought or looked at the Doxygen PlantUML approach. I check out the issue and comment there. |
Beta Was this translation helpful? Give feedback.
-
|
I didn't study it either but the |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
We have several Markdown (
.md) files that contain Mermaid diagrams.I managed to get this working by using an filter script similar to this one.
However, if a diagram contains a name that Doxygen can link, it will mess up the mermaid code by adding an
<a>tag in it.In general I like the idea of auto linking, but to my surprise I could not find a way to tell Doxygen to not perform auto linking in a certain section.
How can this be achieved?
Adding
%doesn't work that well, as that would break rendering in other viewers, and symbols/names may change/be added after a diagram has been made.Beta Was this translation helpful? Give feedback.
All reactions