marked-katex-extension-ts

This project is typescript rewrite to marked-katex-extension.

Render katex code in marked

Note: Block level katex requires at least 2 $ at the beginning and end.

1This is inline katex: $c = \\pm\\sqrt{a^2 + b^2}$
2
3This is block level katex:
4
5$$
6c = \\pm\\sqrt{a^2 + b^2}
7$$

You will still need to include the css in your html document to allow katex styles.

1<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.16.2/dist/katex.min.css" integrity="sha384-bYdxxUwYipFNohQlHt0bjN/LCpueqWz13HufFEV1SUatKs1cm4L6fFgCi1jT643X" crossorigin="anonymous">

Usage

1const {marked} = require("marked");
2const markedKatex = require("marked-katex-extension");
3
4// or ES Module script
5// import marked from "https://cdn.jsdelivr.net/gh/markedjs/marked/lib/marked.esm.js";
6// import markedKatex from "https://cdn.jsdelivr.net/gh/UziTech/marked-katex-extension/lib/index.mjs";
7
8const options = {
9  throwOnError: false
10};
11
12marked.use(markedKatex(options));
13
14marked("katex: $c = \\pm\\sqrt{a^2 + b^2}$");

options

Options are sent directly to katex.renderToString