@mdit/plugin-mathjax-slim 0.26.1 → 0.26.2

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/dist/index.d.ts CHANGED
@@ -1,335 +1,335 @@
1
1
  import { MarkdownItTexOptions } from "@mdit/plugin-tex";
2
- import { LiteAdaptor } from "@mathjax/src/js/adaptors/liteAdaptor.js";
3
- import { TeX } from "@mathjax/src/js/input/tex.js";
4
- import { CHTML } from "@mathjax/src/js/output/chtml.js";
5
- import { SVG } from "@mathjax/src/js/output/svg.js";
2
+ import { LiteElement } from "@mathjax/src/js/adaptors/lite/Element.js";
3
+ import { MathDocument } from "@mathjax/src/js/core/MathDocument.js";
4
+ import { MathItem } from "@mathjax/src/js/core/MathItem.js";
6
5
  import { MmlNode } from "@mathjax/src/js/core/MmlTree/MmlNode.js";
6
+ import { TeX } from "@mathjax/src/js/input/tex.js";
7
7
  import TexError from "@mathjax/src/js/input/tex/TexError.js";
8
8
  import { ChtmlFontData } from "@mathjax/src/js/output/chtml/FontData.js";
9
- import { SvgFontData } from "@mathjax/src/js/output/svg/FontData.js";
10
- import { MathItem } from "@mathjax/src/js/core/MathItem.js";
11
- import { LiteElement } from "@mathjax/src/js/adaptors/lite/Element.js";
12
- import { MathDocument } from "@mathjax/src/js/core/MathDocument.js";
13
- import { CssStyles } from "@mathjax/src/js/ui/menu/mj-context-menu.js";
9
+ import { ChtmlWrapperFactory } from "@mathjax/src/js/output/chtml/WrapperFactory.js";
14
10
  import { LinebreakVisitor } from "@mathjax/src/js/output/common/LinebreakVisitor.js";
11
+ import { SvgFontData } from "@mathjax/src/js/output/svg/FontData.js";
15
12
  import { SvgWrapperFactory } from "@mathjax/src/js/output/svg/WrapperFactory.js";
16
- import { ChtmlWrapperFactory } from "@mathjax/src/js/output/chtml/WrapperFactory.js";
13
+ import { CssStyles } from "@mathjax/src/js/ui/menu/mj-context-menu.js";
14
+ import { LiteAdaptor } from "@mathjax/src/js/adaptors/liteAdaptor.js";
15
+ import { CHTML } from "@mathjax/src/js/output/chtml.js";
16
+ import { SVG } from "@mathjax/src/js/output/svg.js";
17
17
  import MarkdownIt from "markdown-it";
18
18
 
19
19
  //#region src/mathjax.d.ts
20
20
  type TexPackage = "action" | "ams" | "amscd" | "bbm" | "bboldx" | "bbox" | "begingroup" | "boldsymbol" | "braket" | "bussproofs" | "cancel" | "cases" | "centernot" | "color" | "colortbl" | "colorv2" | "configmacros" | "dsfont" | "empheq" | "enclose" | "extpfeil" | "gensymb" | "html" | "mathtools" | "mhchem" | "newcommand" | "noerrors" | "noundefined" | "physics" | "setoptions" | "tagformat" | "texhtml" | "textcomp" | "textmacros" | "unicode" | "units" | "upgreek" | "verb";
21
21
  interface MathJaxTexInputOptions {
22
22
  /**
23
- * extensions to use
24
- *
25
- * @default [
26
- * 'action',
27
- * 'ams',
28
- * 'amscd',
29
- * 'bbm',
30
- * 'bboldx',
31
- * 'bbox',
32
- * 'begingroup',
33
- * 'boldsymbol',
34
- * 'braket',
35
- * 'bussproofs',
36
- * 'cancel',
37
- * 'cases',
38
- * 'centernot',
39
- * 'color',
40
- * 'colortbl',
41
- * 'colorv2',
42
- * 'configmacros',
43
- * 'dsfont',
44
- * 'empheq',
45
- * 'enclose',
46
- * 'extpfeil',
47
- * 'gensymb',
48
- * 'html',
49
- * 'mathtools',
50
- * 'mhchem',
51
- * 'newcommand',
52
- * 'noerrors',
53
- * 'noundefined',
54
- * 'physics',
55
- * 'require',
56
- * 'setoptions',
57
- * 'tagformat',
58
- * 'texhtml',
59
- * 'textcomp',
60
- * 'textmacros',
61
- * 'unicode',
62
- * 'units',
63
- * 'upgreek',
64
- * 'verb',
65
- * ]
66
- */
23
+ * extensions to use
24
+ *
25
+ * @default [
26
+ * 'action',
27
+ * 'ams',
28
+ * 'amscd',
29
+ * 'bbm',
30
+ * 'bboldx',
31
+ * 'bbox',
32
+ * 'begingroup',
33
+ * 'boldsymbol',
34
+ * 'braket',
35
+ * 'bussproofs',
36
+ * 'cancel',
37
+ * 'cases',
38
+ * 'centernot',
39
+ * 'color',
40
+ * 'colortbl',
41
+ * 'colorv2',
42
+ * 'configmacros',
43
+ * 'dsfont',
44
+ * 'empheq',
45
+ * 'enclose',
46
+ * 'extpfeil',
47
+ * 'gensymb',
48
+ * 'html',
49
+ * 'mathtools',
50
+ * 'mhchem',
51
+ * 'newcommand',
52
+ * 'noerrors',
53
+ * 'noundefined',
54
+ * 'physics',
55
+ * 'require',
56
+ * 'setoptions',
57
+ * 'tagformat',
58
+ * 'texhtml',
59
+ * 'textcomp',
60
+ * 'textmacros',
61
+ * 'unicode',
62
+ * 'units',
63
+ * 'upgreek',
64
+ * 'verb',
65
+ * ]
66
+ */
67
67
  packages?: TexPackage[];
68
68
  /**
69
- * pattern for recognizing numbers
70
- *
71
- * @default /^(?:[0-9]+(?:\{,\}[0-9]{3})*(?:\.[0-9]*)?|\.[0-9]+)/
72
- */
69
+ * pattern for recognizing numbers
70
+ *
71
+ * @default /^(?:[0-9]+(?:\{,\}[0-9]{3})*(?:\.[0-9]*)?|\.[0-9]+)/
72
+ */
73
73
  digits?: RegExp;
74
74
  tags?: "ams" | "all" | "none";
75
75
  /**
76
- * side for `\tag` macros
77
- */
76
+ * side for `\tag` macros
77
+ */
78
78
  tagSide?: "left" | "right";
79
79
  /**
80
- * amount to indent tags
81
- *
82
- * @default "0.8em"
83
- */
80
+ * amount to indent tags
81
+ *
82
+ * @default "0.8em"
83
+ */
84
84
  tagIndent?: "0.8em";
85
85
  /**
86
- * use label name rather than tag for ids
87
- *
88
- * @default true;
89
- */
86
+ * use label name rather than tag for ids
87
+ *
88
+ * @default true;
89
+ */
90
90
  useLabelIds?: boolean;
91
91
  /**
92
- * maximum number of macro substitutions per expression
93
- *
94
- * @default 1000
95
- */
92
+ * maximum number of macro substitutions per expression
93
+ *
94
+ * @default 1000
95
+ */
96
96
  maxMacros?: number;
97
97
  /**
98
- * maximum size for the internal TeX string (in bytes)
99
- *
100
- * @default 5120
101
- */
98
+ * maximum size for the internal TeX string (in bytes)
99
+ *
100
+ * @default 5120
101
+ */
102
102
  maxBuffer?: number;
103
103
  formatError?: (jax: TeX<unknown, unknown, unknown>, error: typeof TexError) => MmlNode;
104
104
  }
105
105
  /**
106
- * Data passed to MathJax filters
107
- */
106
+ * Data passed to MathJax filters
107
+ */
108
108
  interface MathjaxFilterData {
109
109
  math: MathItem<LiteElement, string, HTMLElement>;
110
110
  document: MathDocument<LiteElement, string, HTMLElement>;
111
111
  data: any;
112
112
  }
113
113
  /**
114
- * MathJax filter function
115
- */
114
+ * MathJax filter function
115
+ */
116
116
  type MathjaxFilter = (data: MathjaxFilterData) => void;
117
117
  /**
118
- * @see https://docs.mathjax.org/en/latest/options/output/index.html#option-descriptions
119
- */
118
+ * @see https://docs.mathjax.org/en/latest/options/output/index.html#option-descriptions
119
+ */
120
120
  interface MathjaxCommonOutputOptions {
121
121
  /**
122
- * Global scaling factor for all expressions
123
- *
124
- * @default 1
125
- */
122
+ * Global scaling factor for all expressions
123
+ *
124
+ * @default 1
125
+ */
126
126
  scale?: number;
127
127
  /**
128
- * smallest scaling factor to use
129
- *
130
- * @default 0.5
131
- */
128
+ * smallest scaling factor to use
129
+ *
130
+ * @default 0.5
131
+ */
132
132
  minScale?: number;
133
133
  /**
134
- * make mtext elements use surrounding font
135
- *
136
- * @default false
137
- */
134
+ * make mtext elements use surrounding font
135
+ *
136
+ * @default false
137
+ */
138
138
  mtextInheritFont?: boolean;
139
139
  /**
140
- * make merror text use surrounding font
141
- *
142
- * @default true
143
- */
140
+ * make merror text use surrounding font
141
+ *
142
+ * @default true
143
+ */
144
144
  merrorInheritFont?: boolean;
145
145
  /**
146
- * font to use for mtext, if not inheriting (empty means use MathJax fonts)
147
- *
148
- * @default ""
149
- */
146
+ * font to use for mtext, if not inheriting (empty means use MathJax fonts)
147
+ *
148
+ * @default ""
149
+ */
150
150
  mtextFont?: string;
151
151
  /**
152
- * font to use for merror, if not inheriting (empty means use MathJax fonts)
153
- *
154
- * @default "serif"
155
- */
152
+ * font to use for merror, if not inheriting (empty means use MathJax fonts)
153
+ *
154
+ * @default "serif"
155
+ */
156
156
  merrorFont?: string;
157
157
  /**
158
- * font to use for character that aren’t in MathJax's fonts
159
- *
160
- * @default "serif"
161
- */
158
+ * font to use for character that aren’t in MathJax's fonts
159
+ *
160
+ * @default "serif"
161
+ */
162
162
  unknownFamily?: string;
163
163
  /**
164
- * - `true` for MathML spacing rules
165
- * - `false` for TeX rules
166
- *
167
- * @default false
168
- */
164
+ * - `true` for MathML spacing rules
165
+ * - `false` for TeX rules
166
+ *
167
+ * @default false
168
+ */
169
169
  mathmlSpacing?: boolean;
170
170
  /**
171
- * RFDa and other attributes NOT to copy to the output
172
- */
171
+ * RFDa and other attributes NOT to copy to the output
172
+ */
173
173
  skipAttributes?: Record<string, boolean>;
174
174
  /**
175
- * default size of ex in em units
176
- *
177
- * @default 0.5
178
- */
175
+ * default size of ex in em units
176
+ *
177
+ * @default 0.5
178
+ */
179
179
  exFactor?: number;
180
180
  /**
181
- * default for indentalign when set to 'auto'
182
- *
183
- * @default "center"
184
- */
181
+ * default for indentalign when set to 'auto'
182
+ *
183
+ * @default "center"
184
+ */
185
185
  displayAlign?: "left" | "center" | "right";
186
186
  /**
187
- * default for indentshift when set to 'auto'
188
- *
189
- * @default 0
190
- */
187
+ * default for indentshift when set to 'auto'
188
+ *
189
+ * @default 0
190
+ */
191
191
  displayIndent?: string;
192
192
  /**
193
- * default for overflow
194
- *
195
- * @default "overflow"
196
- */
193
+ * default for overflow
194
+ *
195
+ * @default "overflow"
196
+ */
197
197
  displayOverflow?: "scroll" | "scale" | "truncate" | "elide" | "linebreak" | "overflow";
198
198
  /**
199
- * options for when overflow is linebreak
200
- */
199
+ * options for when overflow is linebreak
200
+ */
201
201
  linebreaks?: {
202
202
  /**
203
- * true for browser-based breaking of inline equations
204
- *
205
- * @default true
206
- */
203
+ * true for browser-based breaking of inline equations
204
+ *
205
+ * @default true
206
+ */
207
207
  inline?: boolean;
208
208
  /**
209
- * a fixed size or a percentage of the container width
210
- *
211
- * @default "100%"
212
- */
209
+ * a fixed size or a percentage of the container width
210
+ *
211
+ * @default "100%"
212
+ */
213
213
  width?: string;
214
214
  /**
215
- * the default lineleading in em units
216
- *
217
- * @default 0.2
218
- */
215
+ * the default lineleading in em units
216
+ *
217
+ * @default 0.2
218
+ */
219
219
  lineleading?: number;
220
220
  /**
221
- * for developers only
222
- */
221
+ * for developers only
222
+ */
223
223
  LinebreakVisitor?: typeof LinebreakVisitor;
224
224
  };
225
225
  /**
226
- * the font component to load
227
- *
228
- * @default ""
229
- */
226
+ * the font component to load
227
+ *
228
+ * @default ""
229
+ */
230
230
  font?: string;
231
231
  /**
232
- * The path to the font definitions
233
- *
234
- * @default "https://cdn.jsdelivr.net/npm/@mathjax/mathjax-newcm-font/"
235
- */
232
+ * The path to the font definitions
233
+ *
234
+ * @default "https://cdn.jsdelivr.net/npm/@mathjax/mathjax-newcm-font/"
235
+ */
236
236
  fontPath?: string;
237
237
  /**
238
- * The font extensions to load
239
- *
240
- * @default []
241
- */
238
+ * The font extensions to load
239
+ *
240
+ * @default []
241
+ */
242
242
  fontExtensions?: string[];
243
243
  /**
244
- * 'use', 'force', or 'ignore' data-mjx-hdw attributes
245
- *
246
- * @default "auto"
247
- */
244
+ * 'use', 'force', or 'ignore' data-mjx-hdw attributes
245
+ *
246
+ * @default "auto"
247
+ */
248
248
  htmlHDW?: "use" | "force" | "ignore";
249
249
  /**
250
- * A list of pre-filters to add to the output jax
251
- *
252
- * @default []
253
- */
250
+ * A list of pre-filters to add to the output jax
251
+ *
252
+ * @default []
253
+ */
254
254
  preFilters?: MathjaxFilter[];
255
255
  /**
256
- * A list of post-filters to add to the output jax
257
- *
258
- * @default []
259
- */
256
+ * A list of post-filters to add to the output jax
257
+ *
258
+ * @default []
259
+ */
260
260
  postFilters?: MathjaxFilter[];
261
261
  /**
262
- * for developers only
263
- */
262
+ * for developers only
263
+ */
264
264
  cssStyles?: typeof CssStyles;
265
265
  }
266
266
  interface MathjaxCommonHTMLOutputOptions extends MathjaxCommonOutputOptions {
267
267
  /**
268
- * Whether match ex-height of surrounding font
269
- *
270
- * @default true
271
- */
268
+ * Whether match ex-height of surrounding font
269
+ *
270
+ * @default true
271
+ */
272
272
  matchFontHeight?: boolean;
273
273
  /**
274
- * Font data to use
275
- *
276
- * @default font data from `@mathjax/mathjax-newcm-font`
277
- */
274
+ * Font data to use
275
+ *
276
+ * @default font data from `@mathjax/mathjax-newcm-font`
277
+ */
278
278
  fontData?: typeof ChtmlFontData;
279
279
  /**
280
- * The URL where the fonts are found
281
- *
282
- * @default jsdelivr CDN links for `@mathjax/mathjax-newcm-font`
283
- */
280
+ * The URL where the fonts are found
281
+ *
282
+ * @default jsdelivr CDN links for `@mathjax/mathjax-newcm-font`
283
+ */
284
284
  fontURL?: string;
285
285
  /**
286
- * location where MathJax should look for font data that has to be loaded dynamically.
287
- *
288
- * @default jsdelivr CDN links for `@mathjax/mathjax-newcm-font`
289
- */
286
+ * location where MathJax should look for font data that has to be loaded dynamically.
287
+ *
288
+ * @default jsdelivr CDN links for `@mathjax/mathjax-newcm-font`
289
+ */
290
290
  dynamicPrefix?: string;
291
291
  /**
292
- * Whether only produce CSS that is used in the processed equations
293
- *
294
- * @default true
295
- */
292
+ * Whether only produce CSS that is used in the processed equations
293
+ *
294
+ * @default true
295
+ */
296
296
  adaptiveCSS?: boolean;
297
297
  /**
298
- * for developers only
299
- */
298
+ * for developers only
299
+ */
300
300
  wrapperFactory?: typeof ChtmlWrapperFactory;
301
301
  }
302
302
  interface MathjaxSVGOutputOptions extends MathjaxCommonOutputOptions {
303
303
  /**
304
- * stroke-width to use for SVG character paths in units that are 1/1000 of an em
305
- *
306
- * @default 3
307
- */
304
+ * stroke-width to use for SVG character paths in units that are 1/1000 of an em
305
+ *
306
+ * @default 3
307
+ */
308
308
  blacker?: number;
309
309
  /**
310
- * @see https://docs.mathjax.org/en/latest/options/output/svg.html#option-descriptions
311
- * @default "local"
312
- */
310
+ * @see https://docs.mathjax.org/en/latest/options/output/svg.html#option-descriptions
311
+ * @default "local"
312
+ */
313
313
  fontCache?: "local" | "global" | "none";
314
314
  /**
315
- * Font data to use
316
- *
317
- * @default font data from `@mathjax/mathjax-newcm-font`
318
- */
315
+ * Font data to use
316
+ *
317
+ * @default font data from `@mathjax/mathjax-newcm-font`
318
+ */
319
319
  fontData?: typeof SvgFontData;
320
320
  /**
321
- * Whether the xlink namespace should be included in the href attributes or not
322
- *
323
- * @default true
324
- */
321
+ * Whether the xlink namespace should be included in the href attributes or not
322
+ *
323
+ * @default true
324
+ */
325
325
  useXlink?: boolean;
326
326
  /**
327
- * ID to use for local font cache (for single equation processing)
328
- */
327
+ * ID to use for local font cache (for single equation processing)
328
+ */
329
329
  localID?: string | null;
330
330
  /**
331
- * for developers only
332
- */
331
+ * for developers only
332
+ */
333
333
  wrapperFactory?: typeof SvgWrapperFactory;
334
334
  }
335
335
  //#endregion
@@ -337,44 +337,44 @@ interface MathjaxSVGOutputOptions extends MathjaxCommonOutputOptions {
337
337
  type TeXTransformer = (content: string, displayMode: boolean) => string;
338
338
  interface MarkdownItMathjaxOptions extends Pick<MarkdownItTexOptions, "allowInlineWithSpace" | "delimiters" | "mathFence"> {
339
339
  /**
340
- * Output syntax
341
- *
342
- * 输出格式
343
- *
344
- * @default 'svg'
345
- */
340
+ * Output syntax
341
+ *
342
+ * 输出格式
343
+ *
344
+ * @default 'svg'
345
+ */
346
346
  output?: "chtml" | "svg";
347
347
  /**
348
- * Enable A11y
349
- *
350
- * 是否启用无障碍
351
- *
352
- * @default true
353
- */
348
+ * Enable A11y
349
+ *
350
+ * 是否启用无障碍
351
+ *
352
+ * @default true
353
+ */
354
354
  a11y?: boolean;
355
355
  /**
356
- * TeX input options
357
- *
358
- * TeX 输入选项
359
- */
356
+ * TeX input options
357
+ *
358
+ * TeX 输入选项
359
+ */
360
360
  tex?: MathJaxTexInputOptions;
361
361
  /**
362
- * Common HTML output options
363
- *
364
- * 通用 HTML 输出选项
365
- */
362
+ * Common HTML output options
363
+ *
364
+ * 通用 HTML 输出选项
365
+ */
366
366
  chtml?: MathjaxCommonHTMLOutputOptions;
367
367
  /**
368
- * SVG output options
369
- *
370
- * SVG 输出选项
371
- */
368
+ * SVG output options
369
+ *
370
+ * SVG 输出选项
371
+ */
372
372
  svg?: MathjaxSVGOutputOptions;
373
373
  /**
374
- * transformer on output content
375
- *
376
- * 输出内容的转换器
377
- */
374
+ * transformer on output content
375
+ *
376
+ * 输出内容的转换器
377
+ */
378
378
  transformer?: TeXTransformer;
379
379
  }
380
380
  interface DocumentOptions {
@@ -383,34 +383,34 @@ interface DocumentOptions {
383
383
  enableAssistiveMml: boolean;
384
384
  }
385
385
  /**
386
- * Mathjax instance common options
387
- */
386
+ * Mathjax instance common options
387
+ */
388
388
  interface MathjaxInstance<Sync extends boolean = false> extends Required<Pick<MarkdownItMathjaxOptions, "allowInlineWithSpace" | "delimiters" | "mathFence">> {
389
389
  /**
390
- * Mathjax adaptor
391
- */
390
+ * Mathjax adaptor
391
+ */
392
392
  adaptor: LiteAdaptor;
393
393
  /**
394
- * Mathjax document options
395
- */
394
+ * Mathjax document options
395
+ */
396
396
  documentOptions: DocumentOptions;
397
397
  /**
398
- * Output style for rendered content and clears it
399
- *
400
- * @returns style
401
- */
398
+ * Output style for rendered content and clears it
399
+ *
400
+ * @returns style
401
+ */
402
402
  outputStyle: () => Sync extends true ? string : Promise<string>;
403
403
  /**
404
- * Reset tex (including labels)
405
- */
404
+ * Reset tex (including labels)
405
+ */
406
406
  reset: () => void;
407
407
  /**
408
- * Clear style cache
409
- */
408
+ * Clear style cache
409
+ */
410
410
  clearStyle: () => void;
411
411
  /**
412
- * Output content transformer
413
- */
412
+ * Output content transformer
413
+ */
414
414
  transformer: TeXTransformer | null;
415
415
  }
416
416
  //#endregion