mirror of
https://seed.radicle.dev/rad:z4V1sjrXqjvFdnCUbxPFqd5p4DtH5.git
synced 2026-11-16 11:50:42 +08:00
desktop: Fix math rendering in markdown
The sanitizer allowlist strips KaTeX's markup, and index.html never loaded katex.min.css, so math has only ever shown up as flat text. We now typeset math after sanitizing and load the stylesheet.
This commit is contained in:
@@ -66,6 +66,7 @@
|
||||
<link rel="stylesheet" type="text/css" href="/typography.css" />
|
||||
<link rel="stylesheet" type="text/css" href="/prettylights.css" />
|
||||
<link rel="stylesheet" type="text/css" href="/colors.css" />
|
||||
<link rel="stylesheet" type="text/css" href="/katex.min.css" />
|
||||
<script type="module">
|
||||
// Make global 'Buffer' available to legacy modules.
|
||||
import { Buffer } from "buffer";
|
||||
|
||||
@@ -7,6 +7,7 @@ import type {
|
||||
} from "marked";
|
||||
|
||||
import dompurify from "dompurify";
|
||||
import katex from "katex";
|
||||
import escape from "lodash/escape.js";
|
||||
import { Marked, Renderer as BaseRenderer } from "marked";
|
||||
import { markedEmoji } from "marked-emoji";
|
||||
@@ -191,6 +192,42 @@ const radicleReferenceMarkedExtension: TokenizerExtension & RendererExtension =
|
||||
`<a href="${escape(token.text)}">${escape(token.text)}</a>`,
|
||||
};
|
||||
|
||||
// KaTeX's markup doesn't survive sanitization, so math renders as a
|
||||
// placeholder holding the TeX source, and `renderMath` swaps in KaTeX's
|
||||
// output once the HTML is sanitized.
|
||||
const MATH_CLASS = "math";
|
||||
const MATH_DISPLAY_CLASS = "math-display";
|
||||
|
||||
const mathMarkedExtension: MarkedExtension = {
|
||||
extensions: (
|
||||
katexMarkedExtension().extensions as (TokenizerExtension &
|
||||
RendererExtension)[]
|
||||
).map(extension => ({
|
||||
...extension,
|
||||
renderer: ({ text, displayMode }: Tokens.Generic) => {
|
||||
const classes = displayMode
|
||||
? `${MATH_CLASS} ${MATH_DISPLAY_CLASS}`
|
||||
: MATH_CLASS;
|
||||
const newline = extension.level === "block" ? "\n" : "";
|
||||
return `<code class="${classes}">${escape(text)}</code>${newline}`;
|
||||
},
|
||||
})),
|
||||
};
|
||||
|
||||
function renderMath(html: string): string {
|
||||
const template = document.createElement("template");
|
||||
template.innerHTML = html;
|
||||
for (const element of template.content.querySelectorAll(
|
||||
`code.${MATH_CLASS}`,
|
||||
)) {
|
||||
element.outerHTML = katex.renderToString(element.textContent ?? "", {
|
||||
displayMode: element.classList.contains(MATH_DISPLAY_CLASS),
|
||||
throwOnError: false,
|
||||
});
|
||||
}
|
||||
return template.innerHTML;
|
||||
}
|
||||
|
||||
const TASK_CHECKBOX_CLASS = "task-checkbox";
|
||||
|
||||
export class Renderer extends BaseRenderer {
|
||||
@@ -234,7 +271,7 @@ export class Renderer extends BaseRenderer {
|
||||
export default new Marked();
|
||||
|
||||
export const markdownWithExtensions = new Marked(
|
||||
katexMarkedExtension({ throwOnError: false }),
|
||||
mathMarkedExtension,
|
||||
markedLinkifyIt({ fuzzyLink: false }),
|
||||
markedFootnote({ refMarkers: true }),
|
||||
markedEmoji({ emojis }),
|
||||
@@ -248,12 +285,14 @@ export const markdownWithExtensions = new Marked(
|
||||
);
|
||||
|
||||
export function renderMarkdown(content: string, breaks = false): string {
|
||||
return dompurify.sanitize(
|
||||
markdownWithExtensions.parse(content, {
|
||||
renderer: new Renderer(),
|
||||
breaks,
|
||||
}) as string,
|
||||
sanitizeConfig,
|
||||
return renderMath(
|
||||
dompurify.sanitize(
|
||||
markdownWithExtensions.parse(content, {
|
||||
renderer: new Renderer(),
|
||||
breaks,
|
||||
}) as string,
|
||||
sanitizeConfig,
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
@@ -69,6 +69,10 @@ async function createRichRepo(peer: RadiclePeer) {
|
||||
"graph TD; Start-->Finish",
|
||||
"```",
|
||||
"",
|
||||
"$$",
|
||||
"\\sum_{k=1}^n a_k",
|
||||
"$$",
|
||||
"",
|
||||
].join("\n"),
|
||||
);
|
||||
await Fs.writeFile(
|
||||
@@ -81,7 +85,7 @@ async function createRichRepo(peer: RadiclePeer) {
|
||||
return { rid };
|
||||
}
|
||||
|
||||
test("render alerts, diagrams and repository images in a readme", async ({
|
||||
test("render alerts, diagrams, math and repository images in a readme", async ({
|
||||
page,
|
||||
peer,
|
||||
}) => {
|
||||
@@ -95,6 +99,12 @@ test("render alerts, diagrams and repository images in a readme", async ({
|
||||
await expect(readme.locator(".mermaid-diagram svg")).toBeVisible();
|
||||
await expect(readme.locator(".mermaid-diagram")).toContainText("Finish");
|
||||
|
||||
// KaTeX's stylesheet takes its MathML copy out of the layout. It stays
|
||||
// 1px wide for screen readers, which Playwright counts as visible.
|
||||
const math = readme.locator(".katex-display");
|
||||
await expect(math.locator(".katex-html")).toBeVisible();
|
||||
await expect(math.locator(".katex-mathml")).toHaveCSS("position", "absolute");
|
||||
|
||||
const logoImage = readme.getByRole("img", { name: "Logo" });
|
||||
await expect(logoImage).toHaveAttribute("src", /^blob:/);
|
||||
await expect
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
import { expect, test } from "vitest";
|
||||
|
||||
import { renderMarkdown } from "@app/lib/markdown";
|
||||
|
||||
// DOMPurify under happy-dom drops a document's first element, so each
|
||||
// document starts with a paragraph that isn't under test.
|
||||
function render(content: string): HTMLElement {
|
||||
const element = document.createElement("div");
|
||||
element.innerHTML = renderMarkdown(`intro\n\n${content}`);
|
||||
return element;
|
||||
}
|
||||
|
||||
test("renders inline math with KaTeX", () => {
|
||||
const math = render("inline $3x^{-1}+(1+x)^2$ math").querySelector(
|
||||
"p .katex",
|
||||
);
|
||||
expect(math?.querySelector(".katex-html")).not.toBeNull();
|
||||
expect(math?.querySelector("annotation")?.textContent).toBe(
|
||||
"3x^{-1}+(1+x)^2",
|
||||
);
|
||||
});
|
||||
|
||||
test("renders block math in display mode", () => {
|
||||
const element = render("$$\n\\sum_{k=1}^n a_k\n$$\n");
|
||||
expect(element.querySelector(".katex-display .katex-html")).not.toBeNull();
|
||||
});
|
||||
Reference in New Issue
Block a user