@ai-gui/plugin-katex 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Liang Li
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,22 @@
+# @ai-gui/plugin-katex
+
+KaTeX math plugin for [AIGUI](../../README.md). Renders inline `$…$` and block `$$…$$` math.
+
+## Install
+
+```sh
+pnpm add @ai-gui/plugin-katex
+```
+
+## Usage
+
+```tsx
+import { katex } from "@ai-gui/plugin-katex"
+import { AIRenderer } from "@ai-gui/react"
+
+<AIRenderer plugins={[katex()]} />
+```
+
+The model can then emit `$E = mc^2$` inline or a `$$…$$` block, and it renders as math. Include KaTeX's stylesheet in your app (the package exports `katexCss` for convenience).
+
+See the [root README](../../README.md) for the full plugin list.

package/dist/index.cjs

@@ -0,0 +1,166 @@
+"use strict";
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+const katex = __toESM(require("katex"));
+
+//#region src/index.ts
+/**
+* Render a TeX expression to a KaTeX HTML string.
+*
+* Uses `output: "html"` (no MathML) so the markup is plain `<span class="katex">`
+* elements that survive DOMPurify sanitization in the core Renderer. Never throws:
+* invalid input is rendered as a red error node via `throwOnError: false`.
+*/
+function renderMath(expr, displayMode) {
+	return katex.default.renderToString(expr, {
+		throwOnError: false,
+		output: "html",
+		displayMode
+	});
+}
+/**
+* Decide whether a `$` at `pos` may open and/or close an inline math span.
+* Mirrors the markdown-it-katex delimiter rules: a closer may not sit right
+* after whitespace or right before a digit; an opener may not precede whitespace.
+*/
+function isValidDelim(state, pos) {
+	const max = state.posMax;
+	const prevChar = pos > 0 ? state.src.charCodeAt(pos - 1) : -1;
+	const nextChar = pos + 1 <= max ? state.src.charCodeAt(pos + 1) : -1;
+	let canOpen = true;
+	let canClose = true;
+	if (prevChar === 32 || prevChar === 9 || nextChar >= 48 && nextChar <= 57) canClose = false;
+	if (nextChar === 32 || nextChar === 9) canOpen = false;
+	return {
+		canOpen,
+		canClose
+	};
+}
+/** Inline rule for `$...$`. */
+function mathInline(state, silent) {
+	if (state.src[state.pos] !== "$") return false;
+	let res = isValidDelim(state, state.pos);
+	if (!res.canOpen) {
+		if (!silent) state.pending += "$";
+		state.pos += 1;
+		return true;
+	}
+	const start = state.pos + 1;
+	let match = start;
+	let pos;
+	while ((match = state.src.indexOf("$", match)) !== -1) {
+		pos = match - 1;
+		while (state.src[pos] === "\\") pos -= 1;
+		if ((match - pos) % 2 === 1) break;
+		match += 1;
+	}
+	if (match === -1) {
+		if (!silent) state.pending += "$";
+		state.pos = start;
+		return true;
+	}
+	if (match - start === 0) {
+		if (!silent) state.pending += "$$";
+		state.pos = start + 1;
+		return true;
+	}
+	res = isValidDelim(state, match);
+	if (!res.canClose) {
+		if (!silent) state.pending += "$";
+		state.pos = start;
+		return true;
+	}
+	if (!silent) {
+		const token = state.push("math_inline", "math", 0);
+		token.markup = "$";
+		token.content = state.src.slice(start, match);
+	}
+	state.pos = match + 1;
+	return true;
+}
+/** Block rule for `$$...$$` (single or multi line). */
+function mathBlock(state, start, end, silent) {
+	let firstLine;
+	let lastLine = "";
+	let next;
+	let lastPos;
+	let found = false;
+	let pos = state.bMarks[start] + state.tShift[start];
+	let max = state.eMarks[start];
+	if (pos + 2 > max) return false;
+	if (state.src.slice(pos, pos + 2) !== "$$") return false;
+	pos += 2;
+	firstLine = state.src.slice(pos, max);
+	if (silent) return true;
+	if (firstLine.trim().slice(-2) === "$$") {
+		firstLine = firstLine.trim().slice(0, -2);
+		found = true;
+	}
+	for (next = start; !found;) {
+		next++;
+		if (next >= end) break;
+		pos = state.bMarks[next] + state.tShift[next];
+		max = state.eMarks[next];
+		if (pos < max && state.tShift[next] < state.blkIndent) break;
+		if (state.src.slice(pos, max).trim().slice(-2) === "$$") {
+			lastPos = state.src.slice(0, max).lastIndexOf("$$");
+			lastLine = state.src.slice(pos, lastPos);
+			found = true;
+		}
+	}
+	state.line = next + 1;
+	const token = state.push("math_block", "math", 0);
+	token.block = true;
+	token.content = (firstLine.trim() ? firstLine + "\n" : "") + state.getLines(start + 1, next, state.tShift[start], true) + (lastLine.trim() ? lastLine : "");
+	token.map = [start, state.line];
+	token.markup = "$$";
+	return true;
+}
+/** KaTeX stylesheet import hint — consumers must load KaTeX's CSS for correct layout. */
+const katexCss = "@import \"katex/dist/katex.min.css\";";
+/**
+* KaTeX plugin: renders inline `$...$` and block `$$...$$` math to HTML during
+* markdown parsing, flowing through the core Renderer's sanitized `html` pipeline.
+*/
+function katex$1() {
+	return {
+		name: "katex",
+		css: katexCss,
+		extendParser: (md) => {
+			md.inline.ruler.after("escape", "math_inline", mathInline);
+			md.block.ruler.after("blockquote", "math_block", mathBlock, { alt: [
+				"paragraph",
+				"reference",
+				"blockquote",
+				"list"
+			] });
+			md.renderer.rules.math_inline = (tokens, idx) => renderMath(tokens[idx].content, false);
+			md.renderer.rules.math_block = (tokens, idx) => renderMath(tokens[idx].content, true) + "\n";
+		}
+	};
+}
+
+//#endregion
+exports.katex = katex$1
+exports.katexCss = katexCss

package/dist/index.d.cts

@@ -0,0 +1,14 @@
+import { AIGuiPlugin } from "@ai-gui/core";
+
+//#region src/index.d.ts
+/** KaTeX stylesheet import hint — consumers must load KaTeX's CSS for correct layout. */
+/** KaTeX stylesheet import hint — consumers must load KaTeX's CSS for correct layout. */
+declare const katexCss = "@import \"katex/dist/katex.min.css\";";
+/**
+ * KaTeX plugin: renders inline `$...$` and block `$$...$$` math to HTML during
+ * markdown parsing, flowing through the core Renderer's sanitized `html` pipeline.
+ */
+declare function katex(): AIGuiPlugin;
+
+//#endregion
+export { katex, katexCss };

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+import { AIGuiPlugin } from "@ai-gui/core";
+
+//#region src/index.d.ts
+/** KaTeX stylesheet import hint — consumers must load KaTeX's CSS for correct layout. */
+/** KaTeX stylesheet import hint — consumers must load KaTeX's CSS for correct layout. */
+declare const katexCss = "@import \"katex/dist/katex.min.css\";";
+/**
+ * KaTeX plugin: renders inline `$...$` and block `$$...$$` math to HTML during
+ * markdown parsing, flowing through the core Renderer's sanitized `html` pipeline.
+ */
+declare function katex(): AIGuiPlugin;
+
+//#endregion
+export { katex, katexCss };

package/dist/index.js

@@ -0,0 +1,141 @@
+import katexLib from "katex";
+
+//#region src/index.ts
+/**
+* Render a TeX expression to a KaTeX HTML string.
+*
+* Uses `output: "html"` (no MathML) so the markup is plain `<span class="katex">`
+* elements that survive DOMPurify sanitization in the core Renderer. Never throws:
+* invalid input is rendered as a red error node via `throwOnError: false`.
+*/
+function renderMath(expr, displayMode) {
+	return katexLib.renderToString(expr, {
+		throwOnError: false,
+		output: "html",
+		displayMode
+	});
+}
+/**
+* Decide whether a `$` at `pos` may open and/or close an inline math span.
+* Mirrors the markdown-it-katex delimiter rules: a closer may not sit right
+* after whitespace or right before a digit; an opener may not precede whitespace.
+*/
+function isValidDelim(state, pos) {
+	const max = state.posMax;
+	const prevChar = pos > 0 ? state.src.charCodeAt(pos - 1) : -1;
+	const nextChar = pos + 1 <= max ? state.src.charCodeAt(pos + 1) : -1;
+	let canOpen = true;
+	let canClose = true;
+	if (prevChar === 32 || prevChar === 9 || nextChar >= 48 && nextChar <= 57) canClose = false;
+	if (nextChar === 32 || nextChar === 9) canOpen = false;
+	return {
+		canOpen,
+		canClose
+	};
+}
+/** Inline rule for `$...$`. */
+function mathInline(state, silent) {
+	if (state.src[state.pos] !== "$") return false;
+	let res = isValidDelim(state, state.pos);
+	if (!res.canOpen) {
+		if (!silent) state.pending += "$";
+		state.pos += 1;
+		return true;
+	}
+	const start = state.pos + 1;
+	let match = start;
+	let pos;
+	while ((match = state.src.indexOf("$", match)) !== -1) {
+		pos = match - 1;
+		while (state.src[pos] === "\\") pos -= 1;
+		if ((match - pos) % 2 === 1) break;
+		match += 1;
+	}
+	if (match === -1) {
+		if (!silent) state.pending += "$";
+		state.pos = start;
+		return true;
+	}
+	if (match - start === 0) {
+		if (!silent) state.pending += "$$";
+		state.pos = start + 1;
+		return true;
+	}
+	res = isValidDelim(state, match);
+	if (!res.canClose) {
+		if (!silent) state.pending += "$";
+		state.pos = start;
+		return true;
+	}
+	if (!silent) {
+		const token = state.push("math_inline", "math", 0);
+		token.markup = "$";
+		token.content = state.src.slice(start, match);
+	}
+	state.pos = match + 1;
+	return true;
+}
+/** Block rule for `$$...$$` (single or multi line). */
+function mathBlock(state, start, end, silent) {
+	let firstLine;
+	let lastLine = "";
+	let next;
+	let lastPos;
+	let found = false;
+	let pos = state.bMarks[start] + state.tShift[start];
+	let max = state.eMarks[start];
+	if (pos + 2 > max) return false;
+	if (state.src.slice(pos, pos + 2) !== "$$") return false;
+	pos += 2;
+	firstLine = state.src.slice(pos, max);
+	if (silent) return true;
+	if (firstLine.trim().slice(-2) === "$$") {
+		firstLine = firstLine.trim().slice(0, -2);
+		found = true;
+	}
+	for (next = start; !found;) {
+		next++;
+		if (next >= end) break;
+		pos = state.bMarks[next] + state.tShift[next];
+		max = state.eMarks[next];
+		if (pos < max && state.tShift[next] < state.blkIndent) break;
+		if (state.src.slice(pos, max).trim().slice(-2) === "$$") {
+			lastPos = state.src.slice(0, max).lastIndexOf("$$");
+			lastLine = state.src.slice(pos, lastPos);
+			found = true;
+		}
+	}
+	state.line = next + 1;
+	const token = state.push("math_block", "math", 0);
+	token.block = true;
+	token.content = (firstLine.trim() ? firstLine + "\n" : "") + state.getLines(start + 1, next, state.tShift[start], true) + (lastLine.trim() ? lastLine : "");
+	token.map = [start, state.line];
+	token.markup = "$$";
+	return true;
+}
+/** KaTeX stylesheet import hint — consumers must load KaTeX's CSS for correct layout. */
+const katexCss = "@import \"katex/dist/katex.min.css\";";
+/**
+* KaTeX plugin: renders inline `$...$` and block `$$...$$` math to HTML during
+* markdown parsing, flowing through the core Renderer's sanitized `html` pipeline.
+*/
+function katex() {
+	return {
+		name: "katex",
+		css: katexCss,
+		extendParser: (md) => {
+			md.inline.ruler.after("escape", "math_inline", mathInline);
+			md.block.ruler.after("blockquote", "math_block", mathBlock, { alt: [
+				"paragraph",
+				"reference",
+				"blockquote",
+				"list"
+			] });
+			md.renderer.rules.math_inline = (tokens, idx) => renderMath(tokens[idx].content, false);
+			md.renderer.rules.math_block = (tokens, idx) => renderMath(tokens[idx].content, true) + "\n";
+		}
+	};
+}
+
+//#endregion
+export { katex, katexCss };

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@ai-gui/plugin-katex",
+  "version": "0.1.0",
+  "description": "KaTeX math rendering plugin for AIGUI.",
+  "keywords": [
+    "llm",
+    "ai",
+    "streaming",
+    "markdown",
+    "katex",
+    "math",
+    "latex",
+    "plugin",
+    "aigui"
+  ],
+  "license": "MIT",
+  "author": "Liang Li <ll_faw@hotmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/liliang-cn/aigui.git",
+    "directory": "packages/plugin-katex"
+  },
+  "homepage": "https://github.com/liliang-cn/aigui#readme",
+  "bugs": "https://github.com/liliang-cn/aigui/issues",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "katex": "^0.16.11",
+    "@ai-gui/core": "0.1.0"
+  },
+  "devDependencies": {
+    "@types/katex": "^0.16.7",
+    "@types/markdown-it": "^14.1.2"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "typecheck": "tsc --noEmit"
+  }
+}