Skip to content

docs: render mermaid diagrams on the Pages site #1

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
stephendchu merged 1 commit into from
Jun 13, 2026
Merged

docs: render mermaid diagrams on the Pages site #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 16 additions & 0 deletions _layouts/default.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,21 @@ <h2 class="project-tagline">{{ page.description | default: site.description | de
<span class="site-footer-credits">This page was generated by <a href="https://pages.github.com">GitHub Pages</a>.</span>
</footer>
</main>

<!-- Mermaid: Jekyll/kramdown does not render ```mermaid blocks on its own.
kramdown + Rouge wraps them as <div class="language-mermaid ...">...<code>.
Rewrite each to the <pre class="mermaid"> Mermaid expects, then render. -->
<script type="module">
import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs';
document.querySelectorAll('.language-mermaid, code.language-mermaid').forEach((el) => {
const src = el.querySelector('code') || el;
const pre = document.createElement('pre');
pre.className = 'mermaid';
pre.textContent = src.textContent;
el.replaceWith(pre);
});
mermaid.initialize({ startOnLoad: false, theme: 'default' });
await mermaid.run({ querySelector: 'pre.mermaid' });
</script>
</body>
</html>
Loading