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