Skip to content

feat: mermaid js support for guides #432

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
paulRbr merged 1 commit into from
Jan 29, 2026
+1,626 −702
Merged

feat: mermaid js support for guides #432

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions Gemfile.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ PLATFORMS
arm64-darwin-24
x86_64-darwin-22
x86_64-darwin-23
x86_64-darwin-24
x86_64-linux

DEPENDENCIES
Expand Down
60 changes: 46 additions & 14 deletions frontend/javascript/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
import "$styles/index.css"
import "$styles/syntax-highlighting.css"
import * as Turbo from "@hotwired/turbo"
import { Application } from "@hotwired/stimulus"
import "bridgetown-lit-renderer"
import "bridgetown-quick-search"
import "$styles/index.css";
import "$styles/syntax-highlighting.css";
import * as Turbo from "@hotwired/turbo";
import { Application } from "@hotwired/stimulus";
import "bridgetown-lit-renderer";
import "bridgetown-quick-search";
import mermaid from "mermaid";

/**
* Adds support for declarative shadow DOM. Requires your HTML <head> to include:
* `<meta name="turbo-cache-control" content="no-cache" />`
*/
import * as TurboShadow from "turbo-shadow"
import * as TurboShadow from "turbo-shadow";

/**
* Uncomment the line below to add transition animations when Turbo navigates.
Expand All @@ -19,18 +20,49 @@ import * as TurboShadow from "turbo-shadow"
// import "./turbo_transitions.js"

// Import all JavaScript & CSS files from src/_components
import components from "$components/**/*.{js,jsx,js.rb,css}"
import components from "$components/**/*.{js,jsx,js.rb,css}";

window.Stimulus = Application.start()
window.Stimulus = Application.start();

import controllers from "./controllers/**/*.{js,js.rb}"
import controllers from "./controllers/**/*.{js,js.rb}";
Object.entries(controllers).forEach(([filename, controller]) => {
if (filename.includes("_controller.") || filename.includes("-controller.")) {
const identifier = filename.replace("./controllers/", "")
const identifier = filename
.replace("./controllers/", "")
.replace(/[_-]controller\..*$/, "")
.replace("_", "-")
.replace("/", "--")
.replace("/", "--");

Stimulus.register(identifier, controller.default)
Stimulus.register(identifier, controller.default);
}
})
});

function renderMermaidDiagrams() {
const mermaidCodeBlocks = document.querySelectorAll(
"pre > code.language-mermaid:not([data-mermaid-processed])"
);
if (mermaidCodeBlocks.length === 0) return;

mermaidCodeBlocks.forEach((codeEl) => {
codeEl.setAttribute("data-mermaid-processed", "true");

const preEl = codeEl.parentElement;
if (!preEl) return;

const container = document.createElement("div");
container.className = "mermaid";
container.textContent = codeEl.textContent;

preEl.replaceWith(container);
});

mermaid.initialize({
startOnLoad: false,
securityLevel: "strict",
theme: "default",
});

mermaid.run({ querySelector: ".mermaid" });
}

document.addEventListener("turbo:load", renderMermaidDiagrams);
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
"bridgetown-quick-search": "3.0.3",
"esbuild-plugin-lit-css": "^2.0.4",
"lit": "^2.8.0",
"mermaid": "^11.12.2",
"turbo-shadow": "^1.1.0"
},
"packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
Expand Down
Loading