@isdk/mdast-plus 0.2.0 → 0.2.1

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.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: MdastPipeline
8
8
 
9
- Defined in: [packages/mdast-plus/src/pipeline.ts:399](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L399)
9
+ Defined in: [packages/mdast-plus/src/pipeline.ts:426](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L426)
10
10
 
11
11
  Extended pipeline with convenience methods for common formats.
12
12
 
@@ -20,7 +20,7 @@ Extended pipeline with convenience methods for common formats.
20
20
 
21
21
  > **new MdastPipeline**(`input`): `MdastPipeline`
22
22
 
23
- Defined in: [packages/mdast-plus/src/pipeline.ts:54](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L54)
23
+ Defined in: [packages/mdast-plus/src/pipeline.ts:54](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L54)
24
24
 
25
25
  Initializes a new pipeline instance with the given input.
26
26
 
@@ -46,7 +46,7 @@ Content to process (string, Buffer, VFile, or AST Node).
46
46
 
47
47
  > `protected` **\_data**: `Record`\<`string`, `any`\> = `{}`
48
48
 
49
- Defined in: [packages/mdast-plus/src/pipeline.ts:48](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L48)
49
+ Defined in: [packages/mdast-plus/src/pipeline.ts:48](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L48)
50
50
 
51
51
  #### Inherited from
52
52
 
@@ -58,7 +58,7 @@ Defined in: [packages/mdast-plus/src/pipeline.ts:48](https://github.com/isdk/mda
58
58
 
59
59
  > `protected` **input**: `Compatible`
60
60
 
61
- Defined in: [packages/mdast-plus/src/pipeline.ts:46](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L46)
61
+ Defined in: [packages/mdast-plus/src/pipeline.ts:46](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L46)
62
62
 
63
63
  #### Inherited from
64
64
 
@@ -70,7 +70,7 @@ Defined in: [packages/mdast-plus/src/pipeline.ts:46](https://github.com/isdk/mda
70
70
 
71
71
  > `protected` **queue**: [`MdastPlugin`](../interfaces/MdastPlugin.md)[] = `[]`
72
72
 
73
- Defined in: [packages/mdast-plus/src/pipeline.ts:47](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L47)
73
+ Defined in: [packages/mdast-plus/src/pipeline.ts:47](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L47)
74
74
 
75
75
  #### Inherited from
76
76
 
@@ -82,7 +82,7 @@ Defined in: [packages/mdast-plus/src/pipeline.ts:47](https://github.com/isdk/mda
82
82
 
83
83
  > `protected` **assembleProcessor**(`queue`): `Processor`
84
84
 
85
- Defined in: [packages/mdast-plus/src/pipeline.ts:326](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L326)
85
+ Defined in: [packages/mdast-plus/src/pipeline.ts:347](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L347)
86
86
 
87
87
  Assembles a unified processor based on the sorted plugin queue.
88
88
 
@@ -102,11 +102,47 @@ Assembles a unified processor based on the sorted plugin queue.
102
102
 
103
103
  ***
104
104
 
105
+ ### configure()
106
+
107
+ > **configure**(`pluginName`, ...`options`): `this`
108
+
109
+ Defined in: [packages/mdast-plus/src/pipeline.ts:331](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L331)
110
+
111
+ Modifies the options of a plugin that is already in the pipeline queue.
112
+ Searches from the end of the queue and updates the first match found.
113
+
114
+ #### Parameters
115
+
116
+ ##### pluginName
117
+
118
+ `string`
119
+
120
+ The name of the plugin to modify.
121
+ Matches against explicit plugin name or function name.
122
+
123
+ ##### options
124
+
125
+ ...`any`[]
126
+
127
+ The new options to pass to the plugin (replaces existing options).
128
+
129
+ #### Returns
130
+
131
+ `this`
132
+
133
+ The pipeline instance for chaining.
134
+
135
+ #### Inherited from
136
+
137
+ [`MdastBasePipeline`](MdastBasePipeline.md).[`configure`](MdastBasePipeline.md#configure)
138
+
139
+ ***
140
+
105
141
  ### data()
106
142
 
107
143
  > **data**(`key`, `value?`): `this`
108
144
 
109
- Defined in: [packages/mdast-plus/src/pipeline.ts:64](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L64)
145
+ Defined in: [packages/mdast-plus/src/pipeline.ts:64](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L64)
110
146
 
111
147
  Configures global data for the pipeline, which will be available to all plugins via this.data().
112
148
 
@@ -140,7 +176,7 @@ The pipeline instance for chaining.
140
176
 
141
177
  > `protected` **ensureInputPlugins**(`queue`, `overrides?`, `maxStage?`): `void`
142
178
 
143
- Defined in: [packages/mdast-plus/src/pipeline.ts:149](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L149)
179
+ Defined in: [packages/mdast-plus/src/pipeline.ts:149](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L149)
144
180
 
145
181
  Ensures that input plugins (parser, normalizers) are present in the queue.
146
182
  Adds implicit plugins if no parser is detected.
@@ -173,7 +209,7 @@ Adds implicit plugins if no parser is detected.
173
209
 
174
210
  > **from**(`fmt`, `overrides?`): `this`
175
211
 
176
- Defined in: [packages/mdast-plus/src/pipeline.ts:178](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L178)
212
+ Defined in: [packages/mdast-plus/src/pipeline.ts:178](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L178)
177
213
 
178
214
  Configures the input format and adds its associated plugins to the pipeline.
179
215
 
@@ -207,7 +243,7 @@ The pipeline instance for chaining.
207
243
 
208
244
  > **getFormat**(`id`): `undefined` \| [`MdastFormat`](../interfaces/MdastFormat.md)
209
245
 
210
- Defined in: [packages/mdast-plus/src/pipeline.ts:76](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L76)
246
+ Defined in: [packages/mdast-plus/src/pipeline.ts:76](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L76)
211
247
 
212
248
  Instance-level access to the global format registry.
213
249
 
@@ -231,7 +267,7 @@ Instance-level access to the global format registry.
231
267
 
232
268
  > **priority**(`order`): `this`
233
269
 
234
- Defined in: [packages/mdast-plus/src/pipeline.ts:314](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L314)
270
+ Defined in: [packages/mdast-plus/src/pipeline.ts:314](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L314)
235
271
 
236
272
  Sets the priority order for the most recently added plugin.
237
273
  Plugins with lower order run earlier within the same stage.
@@ -260,7 +296,7 @@ The pipeline instance for chaining.
260
296
 
261
297
  > **to**(`fmt`, `overrides?`): `Promise`\<`VFile`\>
262
298
 
263
- Defined in: [packages/mdast-plus/src/pipeline.ts:198](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L198)
299
+ Defined in: [packages/mdast-plus/src/pipeline.ts:198](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L198)
264
300
 
265
301
  Processes the pipeline and serializes the result into the specified format.
266
302
 
@@ -294,7 +330,7 @@ A promise resolving to a VFile containing the result.
294
330
 
295
331
  > **toAst**(`options?`): `Promise`\<`Root`\>
296
332
 
297
- Defined in: [packages/mdast-plus/src/pipeline.ts:436](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L436)
333
+ Defined in: [packages/mdast-plus/src/pipeline.ts:463](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L463)
298
334
 
299
335
  Finalizes the pipeline and returns the resulting AST (Root node).
300
336
 
@@ -312,7 +348,7 @@ Map for plugin option overrides.
312
348
 
313
349
  ###### stage?
314
350
 
315
- `"parse"` \| `"normalize"` \| `"compile"` \| `"finalize"` \| `"stringify"`
351
+ [`PipelineStage`](../enumerations/PipelineStage.md) \| `"parse"` \| `"normalize"` \| `"compile"` \| `"finalize"` \| `"stringify"`
316
352
 
317
353
  Run the pipeline up to this stage only.
318
354
 
@@ -326,7 +362,7 @@ Run the pipeline up to this stage only.
326
362
 
327
363
  > **toAST**(`options?`): `Promise`\<`Root`\>
328
364
 
329
- Defined in: [packages/mdast-plus/src/pipeline.ts:474](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L474)
365
+ Defined in: [packages/mdast-plus/src/pipeline.ts:501](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L501)
330
366
 
331
367
  Alias for toAst()
332
368
 
@@ -340,7 +376,7 @@ Alias for toAst()
340
376
 
341
377
  ###### stage?
342
378
 
343
- `"parse"` \| `"normalize"` \| `"compile"` \| `"finalize"` \| `"stringify"`
379
+ [`PipelineStage`](../enumerations/PipelineStage.md) \| `"parse"` \| `"normalize"` \| `"compile"` \| `"finalize"` \| `"stringify"`
344
380
 
345
381
  #### Returns
346
382
 
@@ -352,7 +388,7 @@ Alias for toAst()
352
388
 
353
389
  > **toHtml**(): `Promise`\<`string`\>
354
390
 
355
- Defined in: [packages/mdast-plus/src/pipeline.ts:418](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L418)
391
+ Defined in: [packages/mdast-plus/src/pipeline.ts:445](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L445)
356
392
 
357
393
  Finalizes the pipeline and returns the result as an HTML string.
358
394
 
@@ -366,7 +402,7 @@ Finalizes the pipeline and returns the result as an HTML string.
366
402
 
367
403
  > **toHTML**(): `Promise`\<`string`\>
368
404
 
369
- Defined in: [packages/mdast-plus/src/pipeline.ts:472](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L472)
405
+ Defined in: [packages/mdast-plus/src/pipeline.ts:499](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L499)
370
406
 
371
407
  Alias for toHtml()
372
408
 
@@ -380,7 +416,7 @@ Alias for toHtml()
380
416
 
381
417
  > **toHtmlVFile**(): `Promise`\<`VFile`\>
382
418
 
383
- Defined in: [packages/mdast-plus/src/pipeline.ts:426](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L426)
419
+ Defined in: [packages/mdast-plus/src/pipeline.ts:453](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L453)
384
420
 
385
421
  Finalizes the pipeline and returns a VFile containing the HTML result.
386
422
 
@@ -394,7 +430,7 @@ Finalizes the pipeline and returns a VFile containing the HTML result.
394
430
 
395
431
  > **toMarkdown**(): `Promise`\<`string`\>
396
432
 
397
- Defined in: [packages/mdast-plus/src/pipeline.ts:403](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L403)
433
+ Defined in: [packages/mdast-plus/src/pipeline.ts:430](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L430)
398
434
 
399
435
  Finalizes the pipeline and returns the result as a Markdown string.
400
436
 
@@ -408,7 +444,7 @@ Finalizes the pipeline and returns the result as a Markdown string.
408
444
 
409
445
  > **toMarkdownVFile**(): `Promise`\<`VFile`\>
410
446
 
411
- Defined in: [packages/mdast-plus/src/pipeline.ts:411](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L411)
447
+ Defined in: [packages/mdast-plus/src/pipeline.ts:438](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L438)
412
448
 
413
449
  Finalizes the pipeline and returns a VFile containing the Markdown result.
414
450
 
@@ -422,7 +458,7 @@ Finalizes the pipeline and returns a VFile containing the Markdown result.
422
458
 
423
459
  > `protected` **toRuntimeEntry**(`entry`, `defaultStage`, `overrides?`): [`MdastPlugin`](../interfaces/MdastPlugin.md) & `object`
424
460
 
425
- Defined in: [packages/mdast-plus/src/pipeline.ts:100](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L100)
461
+ Defined in: [packages/mdast-plus/src/pipeline.ts:100](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L100)
426
462
 
427
463
  Normalizes a plugin entry for runtime execution.
428
464
 
@@ -454,7 +490,7 @@ Normalizes a plugin entry for runtime execution.
454
490
 
455
491
  > **use**(`plugin`, ...`options`): `this`
456
492
 
457
- Defined in: [packages/mdast-plus/src/pipeline.ts:241](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L241)
493
+ Defined in: [packages/mdast-plus/src/pipeline.ts:241](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L241)
458
494
 
459
495
  Adds a plugin or an array of plugins to the pipeline's compile stage.
460
496
 
@@ -490,7 +526,7 @@ The pipeline instance for chaining.
490
526
 
491
527
  > **useAt**(`stage`, `plugin`, ...`options`): `this`
492
528
 
493
- Defined in: [packages/mdast-plus/src/pipeline.ts:252](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L252)
529
+ Defined in: [packages/mdast-plus/src/pipeline.ts:252](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L252)
494
530
 
495
531
  Adds a plugin or an array of plugins to the pipeline at a specific stage.
496
532
 
@@ -500,7 +536,7 @@ Adds a plugin or an array of plugins to the pipeline at a specific stage.
500
536
 
501
537
  The stage name or numeric value.
502
538
 
503
- `"parse"` | `"normalize"` | `"compile"` | `"finalize"` | `"stringify"`
539
+ [`PipelineStage`](../enumerations/PipelineStage.md) | `"parse"` | `"normalize"` | `"compile"` | `"finalize"` | `"stringify"`
504
540
 
505
541
  ###### plugin
506
542
 
@@ -528,7 +564,7 @@ The pipeline instance for chaining.
528
564
 
529
565
  > **useAt**(`plugin`, ...`options`): `this`
530
566
 
531
- Defined in: [packages/mdast-plus/src/pipeline.ts:259](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L259)
567
+ Defined in: [packages/mdast-plus/src/pipeline.ts:259](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L259)
532
568
 
533
569
  Adds a plugin or an array of plugins to the pipeline. The stage is taken from the plugin object(s).
534
570
 
@@ -538,7 +574,7 @@ Adds a plugin or an array of plugins to the pipeline. The stage is taken from th
538
574
 
539
575
  The MdastPlugin object or an array of them.
540
576
 
541
- [`MdastPlugin`](../interfaces/MdastPlugin.md) | ([`MdastPlugin`](../interfaces/MdastPlugin.md) \| `Plugin`)[]
577
+ [`MdastPlugin`](../interfaces/MdastPlugin.md) | [`MdastPlugin`](../interfaces/MdastPlugin.md)[]
542
578
 
543
579
  ###### options
544
580
 
@@ -562,7 +598,7 @@ The pipeline instance for chaining.
562
598
 
563
599
  > `static` **getFormat**(`id`): `undefined` \| [`MdastFormat`](../interfaces/MdastFormat.md)
564
600
 
565
- Defined in: [packages/mdast-plus/src/pipeline.ts:42](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L42)
601
+ Defined in: [packages/mdast-plus/src/pipeline.ts:42](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L42)
566
602
 
567
603
  Retrieves a registered format by its ID.
568
604
 
@@ -590,7 +626,7 @@ The format definition or undefined if not found.
590
626
 
591
627
  > `static` **register**(`format`): `void`
592
628
 
593
- Defined in: [packages/mdast-plus/src/pipeline.ts:33](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L33)
629
+ Defined in: [packages/mdast-plus/src/pipeline.ts:33](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L33)
594
630
 
595
631
  Registers a global document format.
596
632
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Enumeration: PipelineStage
8
8
 
9
- Defined in: [packages/mdast-plus/src/types.ts:10](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L10)
9
+ Defined in: [packages/mdast-plus/src/types.ts:10](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L10)
10
10
 
11
11
  PipelineStage defines the execution order of plugins in the processing pipeline.
12
12
  Plugins are sorted and executed in ascending order based on these stage values.
@@ -17,7 +17,7 @@ Plugins are sorted and executed in ascending order based on these stage values.
17
17
 
18
18
  > **compile**: `200`
19
19
 
20
- Defined in: [packages/mdast-plus/src/types.ts:16](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L16)
20
+ Defined in: [packages/mdast-plus/src/types.ts:16](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L16)
21
21
 
22
22
  Transformation stage for semantic changes and custom high-level logic.
23
23
 
@@ -27,7 +27,7 @@ Transformation stage for semantic changes and custom high-level logic.
27
27
 
28
28
  > **finalize**: `300`
29
29
 
30
- Defined in: [packages/mdast-plus/src/types.ts:18](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L18)
30
+ Defined in: [packages/mdast-plus/src/types.ts:18](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L18)
31
31
 
32
32
  Finalization stage for preparing the AST for output (e.g., Sanitize, bridge to HAST).
33
33
 
@@ -37,7 +37,7 @@ Finalization stage for preparing the AST for output (e.g., Sanitize, bridge to H
37
37
 
38
38
  > **normalize**: `100`
39
39
 
40
- Defined in: [packages/mdast-plus/src/types.ts:14](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L14)
40
+ Defined in: [packages/mdast-plus/src/types.ts:14](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L14)
41
41
 
42
42
  Normalization stage for cleaning up and canonicalizing the AST (e.g., GFM, Directives).
43
43
 
@@ -47,7 +47,7 @@ Normalization stage for cleaning up and canonicalizing the AST (e.g., GFM, Direc
47
47
 
48
48
  > **parse**: `0`
49
49
 
50
- Defined in: [packages/mdast-plus/src/types.ts:12](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L12)
50
+ Defined in: [packages/mdast-plus/src/types.ts:12](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L12)
51
51
 
52
52
  Initial stage for parsing raw input (e.g., string to AST).
53
53
 
@@ -57,6 +57,6 @@ Initial stage for parsing raw input (e.g., string to AST).
57
57
 
58
58
  > **stringify**: `400`
59
59
 
60
- Defined in: [packages/mdast-plus/src/types.ts:20](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L20)
60
+ Defined in: [packages/mdast-plus/src/types.ts:20](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L20)
61
61
 
62
62
  Final stage for serializing the AST to the target format result.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **astCompiler**(`this`): `void`
10
10
 
11
- Defined in: [packages/mdast-plus/src/formats/ast.ts:16](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/formats/ast.ts#L16)
11
+ Defined in: [packages/mdast-plus/src/formats/ast.ts:16](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/formats/ast.ts#L16)
12
12
 
13
13
  Pass-through compiler that returns the AST as-is.
14
14
  Essential for unified processes that should output an object (the AST)
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **jsonParser**(`this`): `void`
10
10
 
11
- Defined in: [packages/mdast-plus/src/formats/ast.ts:24](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/formats/ast.ts#L24)
11
+ Defined in: [packages/mdast-plus/src/formats/ast.ts:24](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/formats/ast.ts#L24)
12
12
 
13
13
  Parser for stringified JSON AST input.
14
14
  Allows the pipeline to accept a JSON string and treat it as a unist tree.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **mdast**(`input`): [`MdastPipeline`](../classes/MdastPipeline.md)
10
10
 
11
- Defined in: [packages/mdast-plus/src/pipeline.ts:486](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L486)
11
+ Defined in: [packages/mdast-plus/src/pipeline.ts:513](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/pipeline.ts#L513)
12
12
 
13
13
  Entry point for the fluent mdast-plus API.
14
14
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: MdastDataOrigin
8
8
 
9
- Defined in: [packages/mdast-plus/src/types.ts:86](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L86)
9
+ Defined in: [packages/mdast-plus/src/types.ts:86](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L86)
10
10
 
11
11
  Metadata capturing the origin of a node during conversion.
12
12
 
@@ -20,7 +20,7 @@ Metadata capturing the origin of a node during conversion.
20
20
 
21
21
  > **format**: `string`
22
22
 
23
- Defined in: [packages/mdast-plus/src/types.ts:88](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L88)
23
+ Defined in: [packages/mdast-plus/src/types.ts:88](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L88)
24
24
 
25
25
  The original source format.
26
26
 
@@ -30,7 +30,7 @@ The original source format.
30
30
 
31
31
  > `optional` **hash**: `string`
32
32
 
33
- Defined in: [packages/mdast-plus/src/types.ts:92](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L92)
33
+ Defined in: [packages/mdast-plus/src/types.ts:92](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L92)
34
34
 
35
35
  Hash used for caching or change detection.
36
36
 
@@ -40,6 +40,6 @@ Hash used for caching or change detection.
40
40
 
41
41
  > `optional` **raw**: `unknown`
42
42
 
43
- Defined in: [packages/mdast-plus/src/types.ts:90](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L90)
43
+ Defined in: [packages/mdast-plus/src/types.ts:90](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L90)
44
44
 
45
45
  The raw content from the source before conversion.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: MdastFormat
8
8
 
9
- Defined in: [packages/mdast-plus/src/types.ts:66](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L66)
9
+ Defined in: [packages/mdast-plus/src/types.ts:66](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L66)
10
10
 
11
11
  Defines a document format, encompassing its input (parsing) and output (serialization) strategies.
12
12
 
@@ -16,7 +16,7 @@ Defines a document format, encompassing its input (parsing) and output (serializ
16
16
 
17
17
  > `optional` **extensions**: `string`[]
18
18
 
19
- Defined in: [packages/mdast-plus/src/types.ts:72](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L72)
19
+ Defined in: [packages/mdast-plus/src/types.ts:72](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L72)
20
20
 
21
21
  File extensions associated with this format.
22
22
 
@@ -26,7 +26,7 @@ File extensions associated with this format.
26
26
 
27
27
  > **id**: `string`
28
28
 
29
- Defined in: [packages/mdast-plus/src/types.ts:68](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L68)
29
+ Defined in: [packages/mdast-plus/src/types.ts:68](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L68)
30
30
 
31
31
  Unique identifier for the format (e.g., 'markdown', 'html').
32
32
 
@@ -36,7 +36,7 @@ Unique identifier for the format (e.g., 'markdown', 'html').
36
36
 
37
37
  > `optional` **input**: [`MdastPlugin`](MdastPlugin.md)[]
38
38
 
39
- Defined in: [packages/mdast-plus/src/types.ts:77](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L77)
39
+ Defined in: [packages/mdast-plus/src/types.ts:77](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L77)
40
40
 
41
41
  Plugins used for reading this format into a standard AST (Parser + Normalizer).
42
42
 
@@ -46,7 +46,7 @@ Plugins used for reading this format into a standard AST (Parser + Normalizer).
46
46
 
47
47
  > `optional` **mediaTypes**: `string`[]
48
48
 
49
- Defined in: [packages/mdast-plus/src/types.ts:74](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L74)
49
+ Defined in: [packages/mdast-plus/src/types.ts:74](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L74)
50
50
 
51
51
  MIME types associated with this format.
52
52
 
@@ -56,7 +56,7 @@ MIME types associated with this format.
56
56
 
57
57
  > `optional` **output**: [`MdastPlugin`](MdastPlugin.md)[]
58
58
 
59
- Defined in: [packages/mdast-plus/src/types.ts:80](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L80)
59
+ Defined in: [packages/mdast-plus/src/types.ts:80](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L80)
60
60
 
61
61
  Plugins used for serializing the AST into this format (Finalizer + Stringifier).
62
62
 
@@ -66,6 +66,6 @@ Plugins used for serializing the AST into this format (Finalizer + Stringifier).
66
66
 
67
67
  > `optional` **title**: `string`
68
68
 
69
- Defined in: [packages/mdast-plus/src/types.ts:70](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L70)
69
+ Defined in: [packages/mdast-plus/src/types.ts:70](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L70)
70
70
 
71
71
  Human-readable title.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: MdastMark
8
8
 
9
- Defined in: [packages/mdast-plus/src/types.ts:97](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L97)
9
+ Defined in: [packages/mdast-plus/src/types.ts:97](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L97)
10
10
 
11
11
  Represents a highlighted text (mark) node in mdast.
12
12
 
@@ -20,7 +20,7 @@ Represents a highlighted text (mark) node in mdast.
20
20
 
21
21
  > **children**: `PhrasingContent`[]
22
22
 
23
- Defined in: [packages/mdast-plus/src/types.ts:99](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L99)
23
+ Defined in: [packages/mdast-plus/src/types.ts:99](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L99)
24
24
 
25
25
  List of children.
26
26
 
@@ -65,7 +65,7 @@ have a position.
65
65
 
66
66
  > **type**: `"mark"`
67
67
 
68
- Defined in: [packages/mdast-plus/src/types.ts:98](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L98)
68
+ Defined in: [packages/mdast-plus/src/types.ts:98](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L98)
69
69
 
70
70
  Node type.
71
71
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: MdastPlugin
8
8
 
9
- Defined in: [packages/mdast-plus/src/types.ts:33](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L33)
9
+ Defined in: [packages/mdast-plus/src/types.ts:33](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L33)
10
10
 
11
11
  Configuration for a plugin within the mdast-plus pipeline.
12
12
  It wraps a standard unified plugin with execution metadata.
@@ -17,7 +17,7 @@ It wraps a standard unified plugin with execution metadata.
17
17
 
18
18
  > `optional` **after**: `string`
19
19
 
20
- Defined in: [packages/mdast-plus/src/types.ts:60](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L60)
20
+ Defined in: [packages/mdast-plus/src/types.ts:60](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L60)
21
21
 
22
22
  Run this plugin after the named plugin (within the same stage).
23
23
 
@@ -27,7 +27,7 @@ Run this plugin after the named plugin (within the same stage).
27
27
 
28
28
  > `optional` **before**: `string`
29
29
 
30
- Defined in: [packages/mdast-plus/src/types.ts:58](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L58)
30
+ Defined in: [packages/mdast-plus/src/types.ts:58](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L58)
31
31
 
32
32
  Run this plugin before the named plugin (within the same stage).
33
33
 
@@ -37,7 +37,7 @@ Run this plugin before the named plugin (within the same stage).
37
37
 
38
38
  > `optional` **main**: `boolean`
39
39
 
40
- Defined in: [packages/mdast-plus/src/types.ts:56](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L56)
40
+ Defined in: [packages/mdast-plus/src/types.ts:56](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L56)
41
41
 
42
42
  If true, this plugin is considered the "main" plugin for its stage.
43
43
  When multiple plugins exist in the same stage, a 'main' plugin will
@@ -49,7 +49,7 @@ replace the default (first) plugin of that stage.
49
49
 
50
50
  > `optional` **name**: `string`
51
51
 
52
- Defined in: [packages/mdast-plus/src/types.ts:39](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L39)
52
+ Defined in: [packages/mdast-plus/src/types.ts:39](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L39)
53
53
 
54
54
  Optional name for the plugin.
55
55
  Used for identification in overrides and logging.
@@ -61,7 +61,7 @@ If not provided, defaults to the plugin function's name.
61
61
 
62
62
  > `optional` **options**: `any`[]
63
63
 
64
- Defined in: [packages/mdast-plus/src/types.ts:46](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L46)
64
+ Defined in: [packages/mdast-plus/src/types.ts:46](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L46)
65
65
 
66
66
  Arguments passed to the plugin.
67
67
  MUST be an array of arguments (e.g., [optionsObject]).
@@ -72,7 +72,7 @@ MUST be an array of arguments (e.g., [optionsObject]).
72
72
 
73
73
  > `optional` **order**: `number`
74
74
 
75
- Defined in: [packages/mdast-plus/src/types.ts:50](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L50)
75
+ Defined in: [packages/mdast-plus/src/types.ts:50](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L50)
76
76
 
77
77
  Execution priority within the same stage. Lower values run earlier.
78
78
 
@@ -82,7 +82,7 @@ Execution priority within the same stage. Lower values run earlier.
82
82
 
83
83
  > **plugin**: `Plugin`\<`any`[], `any`, `any`\>
84
84
 
85
- Defined in: [packages/mdast-plus/src/types.ts:41](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L41)
85
+ Defined in: [packages/mdast-plus/src/types.ts:41](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L41)
86
86
 
87
87
  The standard unified plugin (attacher) function.
88
88
 
@@ -92,6 +92,6 @@ The standard unified plugin (attacher) function.
92
92
 
93
93
  > `optional` **stage**: [`PipelineStage`](../enumerations/PipelineStage.md) \| `"parse"` \| `"normalize"` \| `"compile"` \| `"finalize"` \| `"stringify"`
94
94
 
95
- Defined in: [packages/mdast-plus/src/types.ts:48](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L48)
95
+ Defined in: [packages/mdast-plus/src/types.ts:48](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L48)
96
96
 
97
97
  The stage in which this plugin should run.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: MdastSub
8
8
 
9
- Defined in: [packages/mdast-plus/src/types.ts:103](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L103)
9
+ Defined in: [packages/mdast-plus/src/types.ts:103](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L103)
10
10
 
11
11
  Represents a subscript text node in mdast.
12
12
 
@@ -20,7 +20,7 @@ Represents a subscript text node in mdast.
20
20
 
21
21
  > **children**: `PhrasingContent`[]
22
22
 
23
- Defined in: [packages/mdast-plus/src/types.ts:105](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L105)
23
+ Defined in: [packages/mdast-plus/src/types.ts:105](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L105)
24
24
 
25
25
  List of children.
26
26
 
@@ -65,7 +65,7 @@ have a position.
65
65
 
66
66
  > **type**: `"sub"`
67
67
 
68
- Defined in: [packages/mdast-plus/src/types.ts:104](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L104)
68
+ Defined in: [packages/mdast-plus/src/types.ts:104](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L104)
69
69
 
70
70
  Node type.
71
71
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: MdastSup
8
8
 
9
- Defined in: [packages/mdast-plus/src/types.ts:109](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L109)
9
+ Defined in: [packages/mdast-plus/src/types.ts:109](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L109)
10
10
 
11
11
  Represents a superscript text node in mdast.
12
12
 
@@ -20,7 +20,7 @@ Represents a superscript text node in mdast.
20
20
 
21
21
  > **children**: `PhrasingContent`[]
22
22
 
23
- Defined in: [packages/mdast-plus/src/types.ts:111](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L111)
23
+ Defined in: [packages/mdast-plus/src/types.ts:111](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L111)
24
24
 
25
25
  List of children.
26
26
 
@@ -65,7 +65,7 @@ have a position.
65
65
 
66
66
  > **type**: `"sup"`
67
67
 
68
- Defined in: [packages/mdast-plus/src/types.ts:110](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/types.ts#L110)
68
+ Defined in: [packages/mdast-plus/src/types.ts:110](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L110)
69
69
 
70
70
  Node type.
71
71