Skip to content

fix(docs): Broken Mermaid/KaTeX Rendering #83

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.

Sign up for GitHub

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
markovejnovic merged 3 commits into from
Aug 3, 2026
Merged

fix(docs): Broken Mermaid/KaTeX Rendering #83

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
84ab264
fix(docs): render Mermaid/KaTeX on swup navigation, not only full load
markovejnovic Jul 13, 2026
5567e24
refactor(docs): use ExDoc's canonical KaTeX/Mermaid recipe
markovejnovic Jul 13, 2026
60bfbe6
deslop
markovejnovic Aug 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 29 additions & 21 deletions mix.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,35 +145,43 @@ defmodule Hyper.MixProject do
]
end

# Load Mermaid in the HTML docs and render any ```mermaid code fences as
# diagrams. ExDoc tags Mermaid blocks with the `mermaid` class.
defp before_closing_body_tag(:html) do
"""
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/katex.min.css" crossorigin="anonymous">
<script defer src="https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/katex.min.js" crossorigin="anonymous"></script>
<script defer src="https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/contrib/auto-render.min.js" crossorigin="anonymous"
onload="renderMathInElement(document.body, {delimiters: [
{left: '$$', right: '$$', display: true},
{left: '$', right: '$', display: false},
{left: '\\\\[', right: '\\\\]', display: true},
{left: '\\\\(', right: '\\\\)', display: false}
]});"></script>
<script src="https://cdn.jsdelivr.net/npm/mermaid@11.4.1/dist/mermaid.min.js" integrity="sha384-rbtjAdnIQE/aQJGEgXrVUlMibdfTSa4PQju4HDhN3sR2PmaKFzhEafuePsl9H/9I" crossorigin="anonymous"></script>
<script defer src="https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/contrib/auto-render.min.js" crossorigin="anonymous"></script>
<script defer src="https://cdn.jsdelivr.net/npm/mermaid@11.4.1/dist/mermaid.min.js" integrity="sha384-rbtjAdnIQE/aQJGEgXrVUlMibdfTSa4PQju4HDhN3sR2PmaKFzhEafuePsl9H/9I" crossorigin="anonymous"></script>
<script>
document.addEventListener("DOMContentLoaded", function () {
mermaid.initialize({
startOnLoad: false,
theme: document.body.className.includes("dark") ? "dark" : "default"
window.addEventListener("exdoc:loaded", () => {
renderMathInElement(document.body, {
delimiters: [
{left: "$$", right: "$$", display: true},
{left: "$", right: "$", display: false}
]
});
});

let mermaidInitialized = false;
window.addEventListener("exdoc:loaded", () => {
if (!mermaidInitialized) {
mermaid.initialize({
startOnLoad: false,
theme: document.body.className.includes("dark") ? "dark" : "default"
});
mermaidInitialized = true;
}

let id = 0;
for (const pre of document.querySelectorAll("pre.mermaid")) {
const code = pre.textContent;
const div = document.createElement("div");
div.className = "mermaid";
div.textContent = code;
pre.replaceWith(div);
for (const codeEl of document.querySelectorAll("pre code.mermaid")) {
const preEl = codeEl.parentElement;
const graphEl = document.createElement("div");
mermaid.render("mermaid-graph-" + id++, codeEl.textContent).then(({svg, bindFunctions}) => {
graphEl.innerHTML = svg;
bindFunctions?.(graphEl);
preEl.insertAdjacentElement("afterend", graphEl);
preEl.remove();
});
}
mermaid.run();
});
</script>
"""
Expand Down
Loading