@mdit/plugin-katex 0.11.0 → 0.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/index.d.ts CHANGED
@@ -21,6 +21,7 @@ interface KatexToken {
21
21
  treatAsRelax: boolean | undefined;
22
22
  }
23
23
  type KatexLogger<MarkdownItEnv = unknown> = (errorCode: "unknownSymbol" | "unicodeTextInMathMode" | "mathVsTextUnits" | "commentAtEnd" | "htmlExtension" | "newLineInDisplayMode", errorMsg: string, token: KatexToken, env: MarkdownItEnv) => "error" | "warn" | "ignore" | void;
24
+ type TeXTransformer = (content: string, displayMode: boolean) => string;
24
25
  interface MarkdownItKatexOptions<MarkdownItEnv = unknown> extends KatexOptions, Pick<MarkdownItTexOptions, "allowInlineWithSpace" | "mathFence"> {
25
26
  /**
26
27
  * Whether enable mhchem extension
@@ -37,13 +38,13 @@ interface MarkdownItKatexOptions<MarkdownItEnv = unknown> extends KatexOptions,
37
38
  */
38
39
  logger?: KatexLogger<MarkdownItEnv>;
39
40
  /**
40
- * @private This is an undocumented option, use at your own risk
41
+ * transformer on output content
41
42
  *
42
- * @default false
43
+ * 输出内容的转换器
43
44
  */
44
- vPre?: boolean;
45
+ transformer?: TeXTransformer;
45
46
  }
46
47
 
47
48
  declare const katex: <MarkdownItEnv = unknown>(md: MarkdownIt, options?: MarkdownItKatexOptions<MarkdownItEnv>) => void;
48
49
 
49
- export { type KatexLogger, type KatexToken, type MarkdownItKatexOptions, katex };
50
+ export { type KatexLogger, type KatexToken, type MarkdownItKatexOptions, type TeXTransformer, katex };
package/lib/index.js CHANGED
@@ -1,4 +1,4 @@
1
- import{createRequire as w}from"node:module";import{tex as d}from"@mdit/plugin-tex";import p from"katex";const n=e=>e.replace(/&/gu,"&amp;").replace(/</gu,"&lt;").replace(/>/gu,"&gt;").replace(/"/gu,"&quot;").replace(/'/gu,"&#039;"),$=w(import.meta.url),S=(e,t,o)=>{try{const r=p.renderToString(e,{...t,displayMode:!1});return o?r.replace(/ class="katex"/g,' v-pre class="katex"'):r}catch(r){return t.throwOnError&&console.warn(r),`<span ${o?"v-pre ":""}class='katex-error' title='${n(r.toString())}'>${n(e)}</span>`}},v=(e,t,o)=>{try{return`<p ${o?"v-pre ":""}class='katex-block'>${p.renderToString(e,{...t,displayMode:!0})}</p>
2
- `}catch(r){return t.throwOnError&&console.warn(r),`<p ${o?"v-pre ":""}class='katex-block katex-error' title='${n(r.toString())}'>${n(e)}</p>
3
- `}},y=(e,t={})=>{const{allowInlineWithSpace:o=!1,mathFence:r=!1,mhchem:s=!1,logger:i=a=>a==="newLineInDisplayMode"?"ignore":"warn",vPre:c=!1,...m}=t;s&&$("katex/contrib/mhchem"),e.use(d,{allowInlineWithSpace:o,mathFence:r,render:(a,g,h)=>{const l={strict:(u,k,x)=>i(u,k,x,h)??"ignore",throwOnError:!1,...m};return g?v(a,l,c):S(a,l,c)}})};export{y as katex};
1
+ import{createRequire as k}from"node:module";import{tex as x}from"@mdit/plugin-tex";import i from"katex";const c=e=>e.replace(/&/gu,"&amp;").replace(/</gu,"&lt;").replace(/>/gu,"&gt;").replace(/"/gu,"&quot;").replace(/'/gu,"&#039;"),S=k(import.meta.url),y=(e,t,n)=>{let r;try{r=i.renderToString(e,{...t,displayMode:!1})}catch(o){t.throwOnError&&console.warn(o),r=`<span class='katex-error' title='${c(o.toString())}'>${c(e)}</span>`}return n?.(r,!1)??r},$=(e,t,n)=>{let r;try{r=`<p class='katex-block'>${i.renderToString(e,{...t,displayMode:!0})}</p>
2
+ `}catch(o){t.throwOnError&&console.warn(o),r=`<p class='katex-block katex-error' title='${c(o.toString())}'>${c(e)}</p>
3
+ `}return n?.(r,!0)??r},f=(e,t={})=>{const{allowInlineWithSpace:n=!1,mathFence:r=!1,mhchem:o=!1,logger:s=a=>a==="newLineInDisplayMode"?"ignore":"warn",transformer:l,...m}=t;o&&S("katex/contrib/mhchem"),e.use(x,{allowInlineWithSpace:n,mathFence:r,render:(a,g,h)=>{const p={strict:(u,w,d)=>s(u,w,d,h)??"ignore",throwOnError:!1,...m};return g?$(a,p,l):y(a,p,l)}})};export{f as katex};
4
4
  //# sourceMappingURL=index.js.map
package/lib/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sources":["../src/utils.ts","../src/plugin.ts"],"sourcesContent":["export const escapeHtml = (unsafeHTML: string): string =>\n unsafeHTML\n .replace(/&/gu, \"&amp;\")\n .replace(/</gu, \"&lt;\")\n .replace(/>/gu, \"&gt;\")\n .replace(/\"/gu, \"&quot;\")\n .replace(/'/gu, \"&#039;\");\n","/* eslint-disable @typescript-eslint/consistent-type-imports */\nimport { createRequire } from \"node:module\";\n\nimport { tex } from \"@mdit/plugin-tex\";\nimport type { KatexOptions as OriginalKatexOptions } from \"katex\";\nimport Katex from \"katex\";\nimport type MarkdownIt from \"markdown-it\";\n\nimport type { KatexToken, MarkdownItKatexOptions } from \"./options.js\";\nimport { escapeHtml } from \"./utils.js\";\n\nconst require = createRequire(import.meta.url);\n\nconst katexInline = (\n tex: string,\n options: OriginalKatexOptions,\n vPre: boolean,\n): string => {\n try {\n const result = Katex.renderToString(tex, {\n ...options,\n displayMode: false,\n });\n\n return vPre\n ? result.replace(/ class=\"katex\"/g, ' v-pre class=\"katex\"')\n : result;\n } catch (error) {\n if (options.throwOnError) console.warn(error);\n\n return `<span ${\n vPre ? \"v-pre \" : \"\"\n }class='katex-error' title='${escapeHtml(\n (error as Error).toString(),\n )}'>${escapeHtml(tex)}</span>`;\n }\n};\n\nconst katexBlock = (\n tex: string,\n options: OriginalKatexOptions,\n vPre: boolean,\n): string => {\n try {\n return `<p ${vPre ? \"v-pre \" : \"\"}class='katex-block'>${Katex.renderToString(\n tex,\n {\n ...options,\n displayMode: true,\n },\n )}</p>\\n`;\n } catch (error) {\n if (options.throwOnError) console.warn(error);\n\n return `<p ${\n vPre ? \"v-pre \" : \"\"\n }class='katex-block katex-error' title='${escapeHtml(\n (error as Error).toString(),\n )}'>${escapeHtml(tex)}</p>\\n`;\n }\n};\n\nexport const katex = <MarkdownItEnv = unknown>(\n md: MarkdownIt,\n options: MarkdownItKatexOptions<MarkdownItEnv> = {},\n): void => {\n const {\n allowInlineWithSpace = false,\n mathFence = false,\n mhchem = false,\n logger = (errorCode: string): string =>\n errorCode === \"newLineInDisplayMode\" ? \"ignore\" : \"warn\",\n vPre = false,\n ...userOptions\n } = options;\n\n if (mhchem) require(\"katex/contrib/mhchem\");\n\n md.use(tex, {\n allowInlineWithSpace,\n mathFence,\n render: (content: string, displayMode: boolean, env: MarkdownItEnv) => {\n const katexOptions = {\n strict: (\n errorCode:\n | \"unknownSymbol\"\n | \"unicodeTextInMathMode\"\n | \"mathVsTextUnits\"\n | \"commentAtEnd\"\n | \"htmlExtension\"\n | \"newLineInDisplayMode\",\n errorMsg: string,\n token: KatexToken,\n ): string => logger(errorCode, errorMsg, token, env) ?? \"ignore\",\n throwOnError: false,\n ...userOptions,\n };\n\n return displayMode\n ? katexBlock(content, katexOptions, vPre)\n : katexInline(content, katexOptions, vPre);\n },\n });\n};\n"],"names":["escapeHtml","unsafeHTML","require","createRequire","katexInline","tex","options","vPre","result","Katex","error","katexBlock","katex","md","allowInlineWithSpace","mathFence","mhchem","logger","errorCode","userOptions","content","displayMode","env","katexOptions","errorMsg","token"],"mappings":"wGAAa,MAAAA,EAAcC,GACzBA,EACG,QAAQ,MAAO,OAAO,EACtB,QAAQ,MAAO,MAAM,EACrB,QAAQ,MAAO,MAAM,EACrB,QAAQ,MAAO,QAAQ,EACvB,QAAQ,MAAO,QAAQ,ECKtBC,EAAUC,EAAc,YAAY,GAAG,EAEvCC,EAAc,CAClBC,EACAC,EACAC,IACW,CACX,GAAI,CACF,MAAMC,EAASC,EAAM,eAAeJ,EAAK,CACvC,GAAGC,EACH,YAAa,EACf,CAAC,EAED,OAAOC,EACHC,EAAO,QAAQ,kBAAmB,sBAAsB,EACxDA,CACN,OAASE,EAAO,CACd,OAAIJ,EAAQ,cAAc,QAAQ,KAAKI,CAAK,EAErC,SACLH,EAAO,SAAW,EACpB,8BAA8BP,EAC3BU,EAAgB,SAAS,CAC5B,CAAC,KAAKV,EAAWK,CAAG,CAAC,SACvB,CACF,EAEMM,EAAa,CACjBN,EACAC,EACAC,IACW,CACX,GAAI,CACF,MAAO,MAAMA,EAAO,SAAW,EAAE,uBAAuBE,EAAM,eAC5DJ,EACA,CACE,GAAGC,EACH,YAAa,EACf,CACF,CAAC;AAAA,CACH,OAASI,EAAO,CACd,OAAIJ,EAAQ,cAAc,QAAQ,KAAKI,CAAK,EAErC,MACLH,EAAO,SAAW,EACpB,0CAA0CP,EACvCU,EAAgB,SACnB,CAAA,CAAC,KAAKV,EAAWK,CAAG,CAAC;AAAA,CACvB,CACF,EAEaO,EAAQ,CACnBC,EACAP,EAAiD,CAAA,IACxC,CACT,KAAM,CACJ,qBAAAQ,EAAuB,GACvB,UAAAC,EAAY,GACZ,OAAAC,EAAS,GACT,OAAAC,EAAUC,GACRA,IAAc,uBAAyB,SAAW,OACpD,KAAAX,EAAO,GACP,GAAGY,CACL,EAAIb,EAEAU,GAAQd,EAAQ,sBAAsB,EAE1CW,EAAG,IAAIR,EAAK,CACV,qBAAAS,EACA,UAAAC,EACA,OAAQ,CAACK,EAAiBC,EAAsBC,IAAuB,CACrE,MAAMC,EAAe,CACnB,OAAQ,CACNL,EAOAM,EACAC,IACWR,EAAOC,EAAWM,EAAUC,EAAOH,CAAG,GAAK,SACxD,aAAc,GACd,GAAGH,CACL,EAEA,OAAOE,EACHV,EAAWS,EAASG,EAAchB,CAAI,EACtCH,EAAYgB,EAASG,EAAchB,CAAI,CAC7C,CACF,CAAC,CACH"}
1
+ {"version":3,"file":"index.js","sources":["../src/utils.ts","../src/plugin.ts"],"sourcesContent":["export const escapeHtml = (unsafeHTML: string): string =>\n unsafeHTML\n .replace(/&/gu, \"&amp;\")\n .replace(/</gu, \"&lt;\")\n .replace(/>/gu, \"&gt;\")\n .replace(/\"/gu, \"&quot;\")\n .replace(/'/gu, \"&#039;\");\n","import { createRequire } from \"node:module\";\n\nimport { tex } from \"@mdit/plugin-tex\";\nimport type { KatexOptions as OriginalKatexOptions } from \"katex\";\nimport Katex from \"katex\";\nimport type MarkdownIt from \"markdown-it\";\n\nimport type {\n KatexToken,\n MarkdownItKatexOptions,\n TeXTransformer,\n} from \"./options.js\";\nimport { escapeHtml } from \"./utils.js\";\n\nconst require = createRequire(import.meta.url);\n\nconst katexInline = (\n tex: string,\n options: OriginalKatexOptions,\n transformer?: TeXTransformer,\n): string => {\n let result: string;\n\n try {\n result = Katex.renderToString(tex, {\n ...options,\n displayMode: false,\n });\n } catch (error) {\n if (options.throwOnError) console.warn(error);\n\n result = `<span class='katex-error' title='${escapeHtml(\n (error as Error).toString(),\n )}'>${escapeHtml(tex)}</span>`;\n }\n\n return transformer?.(result, false) ?? result;\n};\n\nconst katexBlock = (\n tex: string,\n options: OriginalKatexOptions,\n transformer?: TeXTransformer,\n): string => {\n let result: string;\n\n try {\n result = `<p class='katex-block'>${Katex.renderToString(tex, {\n ...options,\n displayMode: true,\n })}</p>\\n`;\n } catch (error) {\n if (options.throwOnError) console.warn(error);\n\n result = `<p class='katex-block katex-error' title='${escapeHtml(\n (error as Error).toString(),\n )}'>${escapeHtml(tex)}</p>\\n`;\n }\n\n return transformer?.(result, true) ?? result;\n};\n\nexport const katex = <MarkdownItEnv = unknown>(\n md: MarkdownIt,\n options: MarkdownItKatexOptions<MarkdownItEnv> = {},\n): void => {\n const {\n allowInlineWithSpace = false,\n mathFence = false,\n mhchem = false,\n logger = (errorCode: string): string =>\n errorCode === \"newLineInDisplayMode\" ? \"ignore\" : \"warn\",\n transformer,\n ...userOptions\n } = options;\n\n if (mhchem) require(\"katex/contrib/mhchem\");\n\n md.use(tex, {\n allowInlineWithSpace,\n mathFence,\n render: (content: string, displayMode: boolean, env: MarkdownItEnv) => {\n const katexOptions = {\n strict: (\n errorCode:\n | \"unknownSymbol\"\n | \"unicodeTextInMathMode\"\n | \"mathVsTextUnits\"\n | \"commentAtEnd\"\n | \"htmlExtension\"\n | \"newLineInDisplayMode\",\n errorMsg: string,\n token: KatexToken,\n ): string => logger(errorCode, errorMsg, token, env) ?? \"ignore\",\n throwOnError: false,\n ...userOptions,\n };\n\n return displayMode\n ? katexBlock(content, katexOptions, transformer)\n : katexInline(content, katexOptions, transformer);\n },\n });\n};\n"],"names":["escapeHtml","unsafeHTML","require","createRequire","katexInline","tex","options","transformer","result","Katex","error","katexBlock","katex","md","allowInlineWithSpace","mathFence","mhchem","logger","errorCode","userOptions","content","displayMode","env","katexOptions","errorMsg","token"],"mappings":"wGAAa,MAAAA,EAAcC,GACzBA,EACG,QAAQ,MAAO,OAAO,EACtB,QAAQ,MAAO,MAAM,EACrB,QAAQ,MAAO,MAAM,EACrB,QAAQ,MAAO,QAAQ,EACvB,QAAQ,MAAO,QAAQ,ECQtBC,EAAUC,EAAc,YAAY,GAAG,EAEvCC,EAAc,CAClBC,EACAC,EACAC,IACW,CACX,IAAIC,EAEJ,GAAI,CACFA,EAASC,EAAM,eAAeJ,EAAK,CACjC,GAAGC,EACH,YAAa,EACf,CAAC,CACH,OAASI,EAAO,CACVJ,EAAQ,cAAc,QAAQ,KAAKI,CAAK,EAE5CF,EAAS,oCAAoCR,EAC1CU,EAAgB,UACnB,CAAC,KAAKV,EAAWK,CAAG,CAAC,SACvB,CAEA,OAAOE,IAAcC,EAAQ,EAAK,GAAKA,CACzC,EAEMG,EAAa,CACjBN,EACAC,EACAC,IACW,CACX,IAAIC,EAEJ,GAAI,CACFA,EAAS,0BAA0BC,EAAM,eAAeJ,EAAK,CAC3D,GAAGC,EACH,YAAa,EACf,CAAC,CAAC;AAAA,CACJ,OAASI,EAAO,CACVJ,EAAQ,cAAc,QAAQ,KAAKI,CAAK,EAE5CF,EAAS,6CAA6CR,EACnDU,EAAgB,SAAS,CAC5B,CAAC,KAAKV,EAAWK,CAAG,CAAC;AAAA,CACvB,CAEA,OAAOE,IAAcC,EAAQ,EAAI,GAAKA,CACxC,EAEaI,EAAQ,CACnBC,EACAP,EAAiD,CACxC,IAAA,CACT,KAAM,CACJ,qBAAAQ,EAAuB,GACvB,UAAAC,EAAY,GACZ,OAAAC,EAAS,GACT,OAAAC,EAAUC,GACRA,IAAc,uBAAyB,SAAW,OACpD,YAAAX,EACA,GAAGY,CACL,EAAIb,EAEAU,GAAQd,EAAQ,sBAAsB,EAE1CW,EAAG,IAAIR,EAAK,CACV,qBAAAS,EACA,UAAAC,EACA,OAAQ,CAACK,EAAiBC,EAAsBC,IAAuB,CACrE,MAAMC,EAAe,CACnB,OAAQ,CACNL,EAOAM,EACAC,IACWR,EAAOC,EAAWM,EAAUC,EAAOH,CAAG,GAAK,SACxD,aAAc,GACd,GAAGH,CACL,EAEA,OAAOE,EACHV,EAAWS,EAASG,EAAchB,CAAW,EAC7CH,EAAYgB,EAASG,EAAchB,CAAW,CACpD,CACF,CAAC,CACH"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mdit/plugin-katex",
3
- "version": "0.11.0",
3
+ "version": "0.13.0",
4
4
  "description": "katex plugin for MarkdownIt",
5
5
  "keywords": [
6
6
  "markdown-it",
@@ -37,9 +37,9 @@
37
37
  ],
38
38
  "dependencies": {
39
39
  "@types/katex": "^0.16.7",
40
- "@types/markdown-it": "^14.1.1",
41
- "katex": "0.16.10",
42
- "@mdit/plugin-tex": "0.11.0"
40
+ "@types/markdown-it": "^14.1.2",
41
+ "katex": "0.16.11",
42
+ "@mdit/plugin-tex": "0.13.0"
43
43
  },
44
44
  "peerDependencies": {
45
45
  "markdown-it": "^14.1.0"