Skip to content
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.

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

FIX: adds katex support for chat #88

Merged
merged 3 commits into from
Aug 12, 2024
Merged
Changes from all commits
Commits
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
96 changes: 54 additions & 42 deletions assets/javascripts/initializers/discourse-math-katex.js
Original file line number Diff line number Diff line change
@@ -1,72 +1,84 @@
import $ from "jquery";
import loadScript from "discourse/lib/load-script";
import { withPluginApi } from "discourse/lib/plugin-api";

function ensureKaTeX() {
return loadScript("/plugins/discourse-math/katex/katex.min.js").then(() => {
return loadScript("/plugins/discourse-math/katex/katex.min.css", {
async function ensureKaTeX() {
try {
await loadScript("/plugins/discourse-math/katex/katex.min.js");
await loadScript("/plugins/discourse-math/katex/katex.min.css", {
css: true,
})
.then(() => {
return loadScript("/plugins/discourse-math/katex/mhchem.min.js");
})
.then(() => {
return loadScript("/plugins/discourse-math/katex/copy-tex.min.js");
});
});
});
await loadScript("/plugins/discourse-math/katex/mhchem.min.js");
await loadScript("/plugins/discourse-math/katex/copy-tex.min.js");
} catch (e) {
// eslint-disable-next-line no-console
console.error("Failed to load KaTeX dependencies.", e);
}
}

function decorate(elem, katexOpts) {
const $elem = $(elem);
katexOpts["displayMode"] = elem.tagName === "DIV";

if ($elem.data("applied-katex")) {
if (elem.dataset.appliedKatex) {
return;
}
$elem.data("applied-katex", true);

if ($elem.hasClass("math")) {
const tag = elem.tagName === "DIV" ? "div" : "span";
const displayClass = tag === "div" ? "block-math" : "inline-math";
const text = $elem.text();
$elem.addClass(`math-container ${displayClass} katex-math`).text("");
window.katex.render(text, elem, katexOpts);
elem.dataset.appliedKatex = true;

if (!elem.classList.contains("math")) {
return;
}

const tag = elem.tagName === "DIV" ? "div" : "span";
const displayClass = tag === "div" ? "block-math" : "inline-math";
const text = elem.textContent;
elem.classList.add("math-container", displayClass, "katex-math");
elem.textContent = "";
window.katex.render(text, elem, katexOpts);
}

function katex($elem) {
if (!$elem || !$elem.find) {
async function katex(elem) {
if (!elem) {
return;
}

const mathElems = $elem.find(".math");

if (mathElems.length > 0) {
ensureKaTeX().then(() => {
// enable persistent macros with are disabled by default: https://katex.org/docs/api.html#persistent-macros
// also enable equation labelling and referencing which are disabled by default
// both of these are enabled in mathjax by default, so now the katex implementation is (more) mathjax compatible
const katexOpts = {
trust: (context) => ["\\htmlId", "\\href"].includes(context.command),
macros: {
"\\eqref": "\\href{###1}{(\\text{#1})}",
"\\ref": "\\href{###1}{\\text{#1}}",
"\\label": "\\htmlId{#1}{}",
},
displayMode: false,
};
mathElems.each((idx, elem) => decorate(elem, katexOpts));
});
const mathElems = elem.querySelectorAll(".math");
if (!mathElems.length > 0) {
return;
}

await ensureKaTeX();

// enable persistent macros with are disabled by default: https://katex.org/docs/api.html#persistent-macros
// also enable equation labelling and referencing which are disabled by default
// both of these are enabled in mathjax by default, so now the katex implementation is (more) mathjax compatible
const katexOpts = {
trust: (context) => ["\\htmlId", "\\href"].includes(context.command),
macros: {
"\\eqref": "\\href{###1}{(\\text{#1})}",
"\\ref": "\\href{###1}{\\text{#1}}",
"\\label": "\\htmlId{#1}{}",
},
displayMode: false,
};
mathElems.forEach((mathElem) => decorate(mathElem, katexOpts));
}

function initializeMath(api) {
api.decorateCooked(
api.decorateCookedElement(
function (elem) {
katex(elem);
},
{ id: "katex" }
);

if (api.decorateChatMessage) {
api.decorateChatMessage(
(element) => {
katex(element);
},
{ id: "katex-chat" }
);
}
}

export default {
Expand Down