stream-markdown-parser 0.0.30 → 0.0.32
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/README.md +1 -2
- package/README.zh-CN.md +1 -2
- package/dist/index.d.ts +27 -6
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +7320 -283
- package/dist/index.js.map +1 -1
- package/package.json +5 -6
package/README.md
CHANGED
|
@@ -287,7 +287,6 @@ This package comes with the following markdown-it plugins pre-configured:
|
|
|
287
287
|
- `markdown-it-sub` - Subscript support (`H~2~O`)
|
|
288
288
|
- `markdown-it-sup` - Superscript support (`x^2^`)
|
|
289
289
|
- `markdown-it-mark` - Highlight/mark support (`==highlighted==`)
|
|
290
|
-
- `markdown-it-emoji` - Emoji support (`:smile:` → 😄)
|
|
291
290
|
- `markdown-it-task-checkbox` - Task list support (`- [ ] Todo`)
|
|
292
291
|
- `markdown-it-ins` - Insert tag support (`++inserted++`)
|
|
293
292
|
- `markdown-it-footnote` - Footnote support
|
|
@@ -331,4 +330,4 @@ MIT © Simon He
|
|
|
331
330
|
|
|
332
331
|
## Related
|
|
333
332
|
|
|
334
|
-
- [stream-markdown-parser](https://github.com/Simon-He95/vue
|
|
333
|
+
- [stream-markdown-parser](https://github.com/Simon-He95/markstream-vue) - Full-featured Vue 3 Markdown renderer
|
package/README.zh-CN.md
CHANGED
|
@@ -286,7 +286,6 @@ import type {
|
|
|
286
286
|
- `markdown-it-sub` - 下标支持(`H~2~O`)
|
|
287
287
|
- `markdown-it-sup` - 上标支持(`x^2^`)
|
|
288
288
|
- `markdown-it-mark` - 高亮/标记支持(`==highlighted==`)
|
|
289
|
-
- `markdown-it-emoji` - Emoji 支持(`:smile:` → 😄)
|
|
290
289
|
- `markdown-it-task-checkbox` - 任务列表支持(`- [ ] Todo`)
|
|
291
290
|
- `markdown-it-ins` - 插入标签支持(`++inserted++`)
|
|
292
291
|
- `markdown-it-footnote` - 脚注支持
|
|
@@ -330,4 +329,4 @@ MIT © Simon He
|
|
|
330
329
|
|
|
331
330
|
## 相关项目
|
|
332
331
|
|
|
333
|
-
- [stream-markdown-parser](https://github.com/Simon-He95/vue
|
|
332
|
+
- [stream-markdown-parser](https://github.com/Simon-He95/markstream-vue) - 功能完整的 Vue 3 Markdown 渲染器
|
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { MarkdownIt as MarkdownIt$1, Token } from "markdown-it-ts";
|
|
1
|
+
import { MarkdownIt, MarkdownIt as MarkdownIt$1, Token } from "markdown-it-ts";
|
|
2
2
|
|
|
3
3
|
//#region src/factory.d.ts
|
|
4
4
|
interface FactoryOptions extends Record<string, unknown> {
|
|
@@ -145,6 +145,10 @@ interface FootnoteReferenceNode extends BaseNode {
|
|
|
145
145
|
type: 'footnote_reference';
|
|
146
146
|
id: string;
|
|
147
147
|
}
|
|
148
|
+
interface FootnoteAnchorNode extends BaseNode {
|
|
149
|
+
type: 'footnote_anchor';
|
|
150
|
+
id: string;
|
|
151
|
+
}
|
|
148
152
|
interface AdmonitionNode extends BaseNode {
|
|
149
153
|
type: 'admonition';
|
|
150
154
|
kind: string;
|
|
@@ -265,15 +269,18 @@ type TransformTokensHook = (tokens: MarkdownToken[]) => MarkdownToken[];
|
|
|
265
269
|
interface ParseOptions {
|
|
266
270
|
preTransformTokens?: TransformTokensHook;
|
|
267
271
|
postTransformTokens?: TransformTokensHook;
|
|
272
|
+
requireClosingStrong?: boolean;
|
|
268
273
|
}
|
|
269
274
|
type PostTransformNodesHook = (nodes: ParsedNode[]) => ParsedNode[];
|
|
270
275
|
//#endregion
|
|
271
276
|
//#region src/parser/inline-parsers/index.d.ts
|
|
272
|
-
declare function parseInlineTokens(tokens: MarkdownToken[], raw?: string, pPreToken?: MarkdownToken
|
|
277
|
+
declare function parseInlineTokens(tokens: MarkdownToken[], raw?: string, pPreToken?: MarkdownToken, options?: {
|
|
278
|
+
requireClosingStrong?: boolean;
|
|
279
|
+
}): ParsedNode[];
|
|
273
280
|
//#endregion
|
|
274
281
|
//#region src/parser/index.d.ts
|
|
275
282
|
declare function parseMarkdownToStructure(markdown: string, md: MarkdownIt$1, options?: ParseOptions): ParsedNode[];
|
|
276
|
-
declare function processTokens(tokens: MarkdownToken[]): ParsedNode[];
|
|
283
|
+
declare function processTokens(tokens: MarkdownToken[], options?: ParseOptions): ParsedNode[];
|
|
277
284
|
//#endregion
|
|
278
285
|
//#region src/config.d.ts
|
|
279
286
|
/**
|
|
@@ -290,6 +297,18 @@ interface MathOptions {
|
|
|
290
297
|
commands?: readonly string[];
|
|
291
298
|
/** Whether to escape standalone '!' (default: true). */
|
|
292
299
|
escapeExclamation?: boolean;
|
|
300
|
+
/**
|
|
301
|
+
* Strict delimiter mode.
|
|
302
|
+
* - When true, only explicit TeX delimiters are recognized as math:
|
|
303
|
+
* inline: `$...$` and `\\(...\\)`; block: `$$...$$` and `\\[...\\]`.
|
|
304
|
+
*
|
|
305
|
+
* Important: authors should write explicit TeX delimiters with escaped
|
|
306
|
+
* backslashes in source (for example, write `\\(...\\)` rather than
|
|
307
|
+
* an unescaped `\(...\)`). Unescaped `\(...\)` cannot be reliably
|
|
308
|
+
* distinguished from ordinary parentheses and may not be parsed as math.
|
|
309
|
+
* - Heuristics and mid-state (unclosed) math detection are disabled.
|
|
310
|
+
*/
|
|
311
|
+
strictDelimiters?: boolean;
|
|
293
312
|
}
|
|
294
313
|
declare function setDefaultMathOptions(opts: MathOptions | undefined): void;
|
|
295
314
|
//#endregion
|
|
@@ -313,16 +332,18 @@ declare function normalizeStandaloneBackslashT(s: string, opts?: MathOptions): s
|
|
|
313
332
|
declare function applyMath(md: MarkdownIt$1, mathOpts?: MathOptions): void;
|
|
314
333
|
//#endregion
|
|
315
334
|
//#region src/index.d.ts
|
|
335
|
+
declare function registerMarkdownPlugin(plugin: unknown): void;
|
|
336
|
+
declare function clearRegisteredMarkdownPlugins(): void;
|
|
316
337
|
interface GetMarkdownOptions extends FactoryOptions {
|
|
317
338
|
plugin?: Array<unknown>;
|
|
318
|
-
apply?: Array<(md: MarkdownIt
|
|
339
|
+
apply?: Array<(md: MarkdownIt) => void>;
|
|
319
340
|
/**
|
|
320
341
|
* Custom translation function or translation map for UI texts
|
|
321
342
|
* @default { 'common.copy': 'Copy' }
|
|
322
343
|
*/
|
|
323
344
|
i18n?: ((key: string) => string) | Record<string, string>;
|
|
324
345
|
}
|
|
325
|
-
declare function getMarkdown(msgId?: string, options?: GetMarkdownOptions): MarkdownIt
|
|
346
|
+
declare function getMarkdown(msgId?: string, options?: GetMarkdownOptions): MarkdownIt;
|
|
326
347
|
//#endregion
|
|
327
|
-
export { AdmonitionNode, BaseNode, BlockquoteNode, CheckboxInputNode, CheckboxNode, CodeBlockNode, CustomComponents, DefinitionItemNode, DefinitionListNode, ESCAPED_TEX_BRACE_COMMANDS, EmojiNode, EmphasisNode, FootnoteNode, FootnoteReferenceNode, GetMarkdownOptions, HardBreakNode, HeadingNode, HighlightNode, HtmlBlockNode, HtmlInlineNode, ImageNode, InlineCodeNode, InlineNode, InsertNode, KATEX_COMMANDS, LinkNode, ListItemNode, ListNode, MarkdownRender, MarkdownToken, MarkdownTokenLite, MathBlockNode, MathInlineNode, type MathOptions, MermaidBlockNode, ParagraphNode, ParseOptions, ParsedNode, PostTransformNodesHook, ReferenceNode, StrikethroughNode, StrongNode, SubscriptNode, SuperscriptNode, TEX_BRACE_COMMANDS, TableCellNode, TableNode, TableRowNode, TextNode, ThematicBreakNode, TransformTokensHook, applyContainers, applyMath, findMatchingClose, getMarkdown, isMathLike, normalizeStandaloneBackslashT, parseFenceToken, parseInlineTokens, parseMarkdownToStructure, processTokens, setDefaultMathOptions };
|
|
348
|
+
export { AdmonitionNode, BaseNode, BlockquoteNode, CheckboxInputNode, CheckboxNode, CodeBlockNode, CustomComponents, DefinitionItemNode, DefinitionListNode, ESCAPED_TEX_BRACE_COMMANDS, EmojiNode, EmphasisNode, FootnoteAnchorNode, FootnoteNode, FootnoteReferenceNode, GetMarkdownOptions, HardBreakNode, HeadingNode, HighlightNode, HtmlBlockNode, HtmlInlineNode, ImageNode, InlineCodeNode, InlineNode, InsertNode, KATEX_COMMANDS, LinkNode, ListItemNode, ListNode, type MarkdownIt, MarkdownRender, MarkdownToken, MarkdownTokenLite, MathBlockNode, MathInlineNode, type MathOptions, MermaidBlockNode, ParagraphNode, ParseOptions, ParsedNode, PostTransformNodesHook, ReferenceNode, StrikethroughNode, StrongNode, SubscriptNode, SuperscriptNode, TEX_BRACE_COMMANDS, TableCellNode, TableNode, TableRowNode, TextNode, ThematicBreakNode, TransformTokensHook, applyContainers, applyMath, clearRegisteredMarkdownPlugins, findMatchingClose, getMarkdown, isMathLike, normalizeStandaloneBackslashT, parseFenceToken, parseInlineTokens, parseMarkdownToStructure, processTokens, registerMarkdownPlugin, setDefaultMathOptions };
|
|
328
349
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","names":[],"sources":["../src/factory.ts","../src/types.ts","../src/parser/inline-parsers/index.ts","../src/parser/index.ts","../src/config.ts","../src/findMatchingClose.ts","../src/parser/inline-parsers/fence-parser.ts","../src/plugins/containers.ts","../src/plugins/isMathLike.ts","../src/plugins/math.ts","../src/index.ts"],"sourcesContent":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"index.d.ts","names":[],"sources":["../src/factory.ts","../src/types.ts","../src/parser/inline-parsers/index.ts","../src/parser/index.ts","../src/config.ts","../src/findMatchingClose.ts","../src/parser/inline-parsers/fence-parser.ts","../src/plugins/containers.ts","../src/plugins/isMathLike.ts","../src/plugins/math.ts","../src/index.ts"],"sourcesContent":[],"mappings":";;;UAYiB,cAAA,SAAuB;sBAClB;;EADL,gBAAA,CAAe,EAAA,OAAA;;;;ECVf,CAAA;AAQjB;;;UARiB,QAAA;;EDUA,GAAA,EAAA,MAAA;;;;ACVjB;AAQiB,UAAA,QAAA,SAAiB,QAAQ,CAAA;EAMzB,IAAA,EAAA,MAAA;EAOA,OAAA,EAAA,MAAA;EAMA,MAAA,CAAA,EAAA,OAAW;AAM5B;AAQiB,UA3BA,WAAA,SAAoB,QA2BC,CAAA;EAKrB,IAAA,EAAA,SAAA;EAiBA,KAAA,EAAA,MAAA;EAOA,IAAA,EAAA,MAAA;EAMA,QAAA,EA1DL,UA0DoB,EAAA;AAKhC;AAQiB,UApEA,aAAA,SAAsB,QAoEI,CAAA;EAO1B,IAAA,EAAA,WAAA;EAIA,QAAA,EA7EL,UA6EqB,EAAA;EASrB,aAAA,CAAA,EAAA,OAAc;AAS1B;AAKiB,UAhGA,UAAA,SAAmB,QAgGT,CAAA;EAEjB,IAAA,EAAA,QAAA;EACF,QAAA,EAjGI,UAiGJ,EAAA;EAH2B,OAAA,CAAA,EAAA,MAAA;;AAMlB,UAhGA,QAAA,SAAiB,QAkGzB,CAAA;EAGQ,IAAA,EAAA,MAAA;EAOA,OAAA,EAAA,OAAA;EAKA,KAAA,CAAA,EAAA,MAAA;EAET,KAAA,EA9GC,YA8GD,EAAA;;AAFoC,UAzG3B,YAAA,SAAqB,QAyGM,CAAA;EAAQ,IAAA,EAAA,WAAA;EAMnC,QAAA,EA7GL,UA6GkB,EAAA;AAM9B;AAKiB,UArHA,aAAA,SAAsB,QAqHa,CAAA;EAKnC,IAAA,EAAA,YAAe;EAOf,QAAA,EAAA,MAAW;EAKX,IAAA,EAAA,MAAA;EAKA,SAAA,CAAA,EAAA,MAAA;EAKA,OAAA,CAAA,EAAA,MAAc;EAKd,OAAA,CAAA,EAAA,OAAW;EAKX,IAAA,CAAA,EAAA,OAAA;EAKA,YAAA,CAAA,EAAA,MAAgB;EAKhB,WAAA,CAAA,EAAA,MAAa;EAKb,GAAA,EAAA,MAAA;AAKjB;AAMiB,UAnKA,aAAA,SAAsB,QAmKQ,CAAA;EAI9B,IAAA,EAAA,YAAe;EAKf,KAAA,CAAA,EAAA,CAAA,MAAA,EAAc,MAAA,CAAA,EAAA,GAAQ,IAAA;EAKtB,GAAA,EAAA,MAAA;EAMA,OAAA,EAAA,MAAA;AAkBjB;AAEY,UApMK,cAAA,SAAuB,QAoMlB,CAAA;EAChB,IAAA,EAAA,aAAA;EACA,OAAA,EAAA,MAAA;EACA,QAAA,EApMM,UAoMN,EAAA;;AAEA,UAnMW,cAAA,SAAuB,QAmMlC,CAAA;EACA,IAAA,EAAA,aAAA;EACA,IAAA,EAAA,MAAA;;AAEA,UAlMW,QAAA,SAAiB,QAkM5B,CAAA;EACA,IAAA,EAAA,MAAA;EACA,IAAA,EAAA,MAAA;EACA,KAAA,EAAA,MAAA,GAAA,IAAA;EACA,IAAA,EAAA,MAAA;EACA,QAAA,EAlMM,UAkMN,EAAA;;AAEA,UAjMW,SAAA,SAAkB,QAiM7B,CAAA;EACA,IAAA,EAAA,OAAA;EACA,GAAA,EAAA,MAAA;EACA,GAAA,EAAA,MAAA;EACA,KAAA,EAAA,MAAA,GAAA,IAAA;;AAEA,UAhMW,iBAAA,SAA0B,QAgMrC,CAAA;EACA,IAAA,EAAA,gBAAA;;AAEA,UA/LW,gBAAA,CA+LX;EACA,IAAA,EAAA;IACA,IAAA,EAAA,YAAA;IACA,QAAA,EAAA,MAAA;IACA,IAAA,EAAA,MAAA;IACA,OAAA,CAAA,EAAA,OAAA;EACA,CAAA;;AAEA,KA9LM,cAAA,GA8LN;EACA,OAAA,EAAA,MAAA;EACA,KAAA,CAAA,EAAA,SAAA;CAAM,GAAA;EACK,OAAA,CAAA,EAAA,SAAgB;EAkCrB,KAAA,EA5ND,QA4NC,EAAA;AAEZ,CAAA;AAOY,UAnOK,cAAA,SAAuB,QAmOK,CAAA;;YAjOjC;;ACjFI,UDoFC,SAAA,SAAkB,QCpFF,CAAA;EACvB,IAAA,EAAA,OAAA;EAEI,MAAA,EDmFJ,YCnFI;EAEX,IAAA,EDkFK,YClFL,EAAA;;UDqFc,YAAA,SAAqB;;SAE7B;AElHT;AAEM,UFmHW,aAAA,SAAsB,QEnHjC,CAAA;EACK,IAAA,EAAA,YAAA;EACR,MAAA,EAAA,OAAA;EAAU,QAAA,EFoHD,UEpHC,EAAA;EAuDG,KAAA,CAAA,EAAA,MAAA,GAAa,OAAA,GAAA,QAAA;;AAAoC,UFiEhD,kBAAA,SAA2B,QEjEqB,CAAA;EAAe,IAAA,EAAA,iBAAA;EAAU,KAAA,EFmEjF,kBEnEiF,EAAA;;UFsEzE,kBAAA,SAA2B;;EG3I3B,IAAA,EH6IT,UG7IoB,EAAA;EAqBZ,UAAA,EHyHF,UGzHE,EAAqB;;UH4HpB,YAAA,SAAqB;;EI1JtB,EAAA,EAAA,MAAA;YJ6JJ;;UAGK,qBAAA,SAA8B;EK5H/B,IAAA,EAAA,oBAAe;;;ULiId,kBAAA,SAA2B;EMlK5B,IAAA,EAAA,iBAAe;;;UNuKd,cAAA,SAAuB;EO1K3B,IAAA,EAAA,YAAA;EAoBA,IAAA,EAAA,MAAA;EA6BG,KAAA,EAAA,MAAU;YP6Hd;;UAGK,UAAA,SAAmB;EQhKvB,IAAA,EAAA,QAAA;EA2JG,QAAA,EROJ,UQPI,EAAA;AAsDhB;UR5CiB,YAAA,SAAqB;;YAE1B;ASnKZ;AAIgB,UTkKC,iBAAA,SAA0B,QSlKG,CAAA;EAwB7B,IAAA,EAAA,eAAmB;EACzB,QAAA,ET2IC,US3ID,EAAA;;AACD,UT6IO,aAAA,SAAsB,QS7I7B,CAAA;EAK2B,IAAA,EAAA,WAAA;EAPO,QAAA,ETiJhC,USjJgC,EAAA;;AAU5B,UT0IC,UAAA,SAAmB,QS1IyC,CAAA;;YT4IjE;;UAGK,aAAA,SAAsB;;YAE3B;;UAGK,eAAA,SAAwB;;YAE7B;;UAGK,YAAA,SAAqB;;;;UAKrB,iBAAA,SAA0B;;;;UAK1B,SAAA,SAAkB;;;;;UAMlB,aAAA,SAAsB;;;UAItB,cAAA,SAAuB;;;;UAKvB,aAAA,SAAsB;;;;UAKtB,aAAA,SAAsB;;;;UAMtB,iBAAA;;;;;;;;;;;;;aAaJ;;;;KAKD,aAAA,IAAiB;;;KAA+C;KAEhE,UAAA,GACN,WACA,cACA,gBACA,WACA,eACA,gBACA,iBACA,WACA,YACA,oBACA,iBACA,YACA,eACA,gBACA,aACA,eACA,oBACA,gBACA,aACA,gBACA,kBACA,eACA,oBACA,YACA,qBACA,qBACA,eACA,wBACA,iBACA,gBACA,iBACA,gBACA,gBACA,gBACA;UACW,gBAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAkCL,mBAAA,YAA+B,oBAAoB;UAE9C,YAAA;uBACM;wBACC;;;KAKZ,sBAAA,WAAiC,iBAAiB;;;iBClT9C,iBAAA,SACN,2CAEI;EFhCG,oBAAe,CAAA,EAAA,OACV;IEiCnB;;;AFlCc,iBGOD,wBAAA,CHP8B,QAAA,EAAA,MAAA,EAAA,EAAA,EGSxC,YHTwC,EAAA,OAAA,CAAA,EGUnC,YHVmC,CAAA,EGW3C,UHX2C,EAAA;iBGkE9B,aAAA,SAAsB,2BAA2B,eAAe;;;;;;AHlEhF;;;;ACVA;AAQA;AAMiB,UGPA,WAAA,CHOY;EAOZ;EAMA,QAAA,CAAA,EAAA,SAAW,MAEhB,EAAA;EAIK;EAQA,iBAAa,CAAA,EAAA,OAElB;EAGK;AAiBjB;AAOA;AAMA;AAKA;AAQA;AAOA;AAIA;AASA;AASA;AAKA;EAEU,gBAAA,CAAA,EAAA,OAAA;;AAFyB,iBG/FnB,qBAAA,CH+FmB,IAAA,EG/FS,WH+FT,GAAA,SAAA,CAAA,EAAA,IAAA;;;iBI7HnB,iBAAA;;;iBCoCA,eAAA,QAAuB,gBAAgB;;;iBCjCvC,eAAA,KAAoB;;;cCHvB;cAoBA;iBA6BG,UAAA;;;cChCH;iBA2JG,6BAAA,mBAAgD;iBAsDhD,SAAA,KAAc,yBAAuB;;;ATtNpC,iBUSD,sBAAA,CVT8B,MAAA,EAAA,OAAA,CAAA,EAAA,IAAA;iBUa9B,8BAAA,CAAA;ATwCC,UShBA,kBAAA,SAA2B,cTgBG,CAAA;EAO9B,MAAA,CAAA,EStBN,KTsBM,CAAA,OAAe,CAAA;EAMf,KAAA,CAAA,ES3BP,KT2BO,CAAA,CAAA,EAAe,ES3BX,UT2BmB,EAAA,GAAA,IAAQ,CAAA;EAK/B;AAQjB;AAOA;AAIA;EASY,IAAA,CAAA,EAAA,CAAA,CAAA,GAAA,EAAA,MAAc,EAAA,GAAA,MAOf,CAAA,GS9D0B,MT8DlB,CAAA,MAAA,EAAA,MAAA,CAAA;AAEnB;AAKiB,iBSlED,WAAA,CTkEW,KAAA,CAAA,EAAA,MAAA,EAAA,OAAA,CAAA,ESlEkD,kBTkElD,CAAA,ESlEyE,UTkEzE"}
|