@isdk/mdast-plus 0.2.2 → 0.2.3

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.
Files changed (29) hide show
  1. package/dist/index.d.mts +13 -6
  2. package/dist/index.d.ts +13 -6
  3. package/dist/index.js +1 -1
  4. package/dist/index.mjs +1 -1
  5. package/docs/_media/CONTRIBUTING.md +35 -0
  6. package/docs/classes/MdastBasePipeline.md +25 -25
  7. package/docs/classes/MdastPipeline.md +32 -32
  8. package/docs/enumerations/PipelineStage.md +6 -6
  9. package/docs/functions/astCompiler.md +1 -1
  10. package/docs/functions/jsonParser.md +1 -1
  11. package/docs/functions/mdast.md +1 -1
  12. package/docs/interfaces/MdastDataOrigin.md +4 -4
  13. package/docs/interfaces/MdastFormat.md +7 -7
  14. package/docs/interfaces/MdastMark.md +3 -3
  15. package/docs/interfaces/MdastPlugin.md +9 -9
  16. package/docs/interfaces/MdastSub.md +3 -3
  17. package/docs/interfaces/MdastSup.md +3 -3
  18. package/docs/interfaces/PipelineRunOptions.md +4 -4
  19. package/docs/interfaces/ReadabilityOptions.md +6 -6
  20. package/docs/type-aliases/PipelineStageName.md +1 -1
  21. package/docs/variables/DefaultPipelineStage.md +1 -1
  22. package/docs/variables/astFormat.md +1 -1
  23. package/docs/variables/htmlFormat.md +1 -1
  24. package/docs/variables/htmlReadability.md +1 -1
  25. package/docs/variables/htmlReadabilityPlugin.md +1 -1
  26. package/docs/variables/htmlReadabilityPlugins.md +1 -1
  27. package/docs/variables/markdownFormat.md +1 -1
  28. package/docs/variables/restoreReadabilityMetaPlugin.md +1 -1
  29. package/package.json +1 -1
package/docs/interfaces/PipelineRunOptions.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: PipelineRunOptions
8
8
 
9
- Defined in: [packages/mdast-plus/src/types.ts:86](https://github.com/isdk/mdast-plus.js/blob/f87faaaa5512a2a313584cbae97a686bf2807b44/src/types.ts#L86)
9
+ Defined in: [packages/mdast-plus/src/types.ts:86](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L86)
10
10
 
11
11
  Options for controlling the pipeline execution.
12
12
 
@@ -16,7 +16,7 @@ Options for controlling the pipeline execution.
16
16
 
17
17
  > `optional` **overrides**: `Record`\<`string`, `any`\>
18
18
 
19
- Defined in: [packages/mdast-plus/src/types.ts:101](https://github.com/isdk/mdast-plus.js/blob/f87faaaa5512a2a313584cbae97a686bf2807b44/src/types.ts#L101)
19
+ Defined in: [packages/mdast-plus/src/types.ts:101](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L101)
20
20
 
21
21
  Map of plugin names to their option overrides.
22
22
 
@@ -26,7 +26,7 @@ Map of plugin names to their option overrides.
26
26
 
27
27
  > `optional` **stage**: [`PipelineStage`](../enumerations/PipelineStage.md) \| `"parse"` \| `"normalize"` \| `"compile"` \| `"finalize"` \| `"stringify"`
28
28
 
29
- Defined in: [packages/mdast-plus/src/types.ts:91](https://github.com/isdk/mdast-plus.js/blob/f87faaaa5512a2a313584cbae97a686bf2807b44/src/types.ts#L91)
29
+ Defined in: [packages/mdast-plus/src/types.ts:91](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L91)
30
30
 
31
31
  Run the pipeline only up to the specified stage.
32
32
  Useful for debugging or inspecting intermediate ASTs.
@@ -37,7 +37,7 @@ Useful for debugging or inspecting intermediate ASTs.
37
37
 
38
38
  > `optional` **stopAtIndex**: `number`
39
39
 
40
- Defined in: [packages/mdast-plus/src/types.ts:97](https://github.com/isdk/mdast-plus.js/blob/f87faaaa5512a2a313584cbae97a686bf2807b44/src/types.ts#L97)
40
+ Defined in: [packages/mdast-plus/src/types.ts:97](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L97)
41
41
 
42
42
  If `stage` is specified, stop execution at this index (0-based)
43
43
  within the list of plugins at that stage.
package/docs/interfaces/ReadabilityOptions.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: ReadabilityOptions
8
8
 
9
- Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:7](https://github.com/isdk/mdast-plus.js/blob/f87faaaa5512a2a313584cbae97a686bf2807b44/src/plugins/html-readability.ts#L7)
9
+ Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:7](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/plugins/html-readability.ts#L7)
10
10
 
11
11
  ## Properties
12
12
 
@@ -14,7 +14,7 @@ Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:7](https://gith
14
14
 
15
15
  > `optional` **hast**: `Record`\<`string`, `any`\>
16
16
 
17
- Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:12](https://github.com/isdk/mdast-plus.js/blob/f87faaaa5512a2a313584cbae97a686bf2807b44/src/plugins/html-readability.ts#L12)
17
+ Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:12](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/plugins/html-readability.ts#L12)
18
18
 
19
19
  ***
20
20
 
@@ -22,7 +22,7 @@ Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:12](https://git
22
22
 
23
23
  > `optional` **jsdom**: `Record`\<`string`, `any`\>
24
24
 
25
- Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:11](https://github.com/isdk/mdast-plus.js/blob/f87faaaa5512a2a313584cbae97a686bf2807b44/src/plugins/html-readability.ts#L11)
25
+ Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:11](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/plugins/html-readability.ts#L11)
26
26
 
27
27
  ***
28
28
 
@@ -30,7 +30,7 @@ Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:11](https://git
30
30
 
31
31
  > `optional` **readability**: `false` \| `Record`\<`string`, `any`\>
32
32
 
33
- Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:10](https://github.com/isdk/mdast-plus.js/blob/f87faaaa5512a2a313584cbae97a686bf2807b44/src/plugins/html-readability.ts#L10)
33
+ Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:10](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/plugins/html-readability.ts#L10)
34
34
 
35
35
  ***
36
36
 
@@ -38,7 +38,7 @@ Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:10](https://git
38
38
 
39
39
  > `optional` **rehype-parse**: `Record`\<`string`, `any`\>
40
40
 
41
- Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:13](https://github.com/isdk/mdast-plus.js/blob/f87faaaa5512a2a313584cbae97a686bf2807b44/src/plugins/html-readability.ts#L13)
41
+ Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:13](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/plugins/html-readability.ts#L13)
42
42
 
43
43
  ***
44
44
 
@@ -46,4 +46,4 @@ Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:13](https://git
46
46
 
47
47
  > `optional` **url**: `string`
48
48
 
49
- Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:9](https://github.com/isdk/mdast-plus.js/blob/f87faaaa5512a2a313584cbae97a686bf2807b44/src/plugins/html-readability.ts#L9)
49
+ Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:9](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/plugins/html-readability.ts#L9)
package/docs/type-aliases/PipelineStageName.md CHANGED
@@ -8,6 +8,6 @@
8
8
 
9
9
  > **PipelineStageName** = keyof *typeof* [`PipelineStage`](../enumerations/PipelineStage.md)
10
10
 
11
- Defined in: [packages/mdast-plus/src/types.ts:27](https://github.com/isdk/mdast-plus.js/blob/f87faaaa5512a2a313584cbae97a686bf2807b44/src/types.ts#L27)
11
+ Defined in: [packages/mdast-plus/src/types.ts:27](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L27)
12
12
 
13
13
  String names corresponding to the PipelineStage levels.
package/docs/variables/DefaultPipelineStage.md CHANGED
@@ -8,6 +8,6 @@
8
8
 
9
9
  > `const` **DefaultPipelineStage**: [`compile`](../enumerations/PipelineStage.md#compile) = `PipelineStage.compile`
10
10
 
11
- Defined in: [packages/mdast-plus/src/types.ts:24](https://github.com/isdk/mdast-plus.js/blob/f87faaaa5512a2a313584cbae97a686bf2807b44/src/types.ts#L24)
11
+ Defined in: [packages/mdast-plus/src/types.ts:24](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L24)
12
12
 
13
13
  The default stage assigned to a plugin if none is specified.
package/docs/variables/astFormat.md CHANGED
@@ -8,7 +8,7 @@
8
8
 
9
9
  > `const` **astFormat**: [`MdastFormat`](../interfaces/MdastFormat.md)
10
10
 
11
- Defined in: [packages/mdast-plus/src/formats/ast.ts:35](https://github.com/isdk/mdast-plus.js/blob/f87faaaa5512a2a313584cbae97a686bf2807b44/src/formats/ast.ts#L35)
11
+ Defined in: [packages/mdast-plus/src/formats/ast.ts:35](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/formats/ast.ts#L35)
12
12
 
13
13
  AST (MDAST) format definition.
14
14
  Supports reading from JSON strings and provides full normalization
package/docs/variables/htmlFormat.md CHANGED
@@ -8,7 +8,7 @@
8
8
 
9
9
  > `const` **htmlFormat**: [`MdastFormat`](../interfaces/MdastFormat.md)
10
10
 
11
- Defined in: [packages/mdast-plus/src/formats/html.ts:71](https://github.com/isdk/mdast-plus.js/blob/f87faaaa5512a2a313584cbae97a686bf2807b44/src/formats/html.ts#L71)
11
+ Defined in: [packages/mdast-plus/src/formats/html.ts:71](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/formats/html.ts#L71)
12
12
 
13
13
  HTML format definition.
14
14
 
package/docs/variables/htmlReadability.md CHANGED
@@ -8,6 +8,6 @@
8
8
 
9
9
  > `const` **htmlReadability**: `Plugin`\<\[[`ReadabilityOptions`](../interfaces/ReadabilityOptions.md)?\], `string`, `Root`\>
10
10
 
11
- Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:19](https://github.com/isdk/mdast-plus.js/blob/f87faaaa5512a2a313584cbae97a686bf2807b44/src/plugins/html-readability.ts#L19)
11
+ Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:19](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/plugins/html-readability.ts#L19)
12
12
 
13
13
  A unified/rehype plugin that uses Mozilla's Readability to parse the input HTML.
package/docs/variables/htmlReadabilityPlugin.md CHANGED
@@ -8,7 +8,7 @@
8
8
 
9
9
  > `const` **htmlReadabilityPlugin**: `object`
10
10
 
11
- Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:119](https://github.com/isdk/mdast-plus.js/blob/f87faaaa5512a2a313584cbae97a686bf2807b44/src/plugins/html-readability.ts#L119)
11
+ Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:119](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/plugins/html-readability.ts#L119)
12
12
 
13
13
  Pre-configured MdastPlugin for html-readability.
14
14
 
package/docs/variables/htmlReadabilityPlugins.md CHANGED
@@ -8,6 +8,6 @@
8
8
 
9
9
  > `const` **htmlReadabilityPlugins**: (\{ `main`: `boolean`; `name`: `string`; `plugin`: `Plugin`\<\[[`ReadabilityOptions`](../interfaces/ReadabilityOptions.md)?\], `string`, `Root`\>; `stage`: [`PipelineStage`](../enumerations/PipelineStage.md); \} \| \{ `after`: `string`; `name`: `string`; `plugin`: () => (`tree`, `file`) => `void`; `stage`: [`PipelineStage`](../enumerations/PipelineStage.md); \})[]
10
10
 
11
- Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:146](https://github.com/isdk/mdast-plus.js/blob/f87faaaa5512a2a313584cbae97a686bf2807b44/src/plugins/html-readability.ts#L146)
11
+ Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:146](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/plugins/html-readability.ts#L146)
12
12
 
13
13
  Combined plugins for HTML readability.
package/docs/variables/markdownFormat.md CHANGED
@@ -8,7 +8,7 @@
8
8
 
9
9
  > `const` **markdownFormat**: [`MdastFormat`](../interfaces/MdastFormat.md)
10
10
 
11
- Defined in: [packages/mdast-plus/src/formats/markdown.ts:103](https://github.com/isdk/mdast-plus.js/blob/f87faaaa5512a2a313584cbae97a686bf2807b44/src/formats/markdown.ts#L103)
11
+ Defined in: [packages/mdast-plus/src/formats/markdown.ts:103](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/formats/markdown.ts#L103)
12
12
 
13
13
  Markdown format definition.
14
14
 
package/docs/variables/restoreReadabilityMetaPlugin.md CHANGED
@@ -8,7 +8,7 @@
8
8
 
9
9
  > `const` **restoreReadabilityMetaPlugin**: `object`
10
10
 
11
- Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:131](https://github.com/isdk/mdast-plus.js/blob/f87faaaa5512a2a313584cbae97a686bf2807b44/src/plugins/html-readability.ts#L131)
11
+ Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:131](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/plugins/html-readability.ts#L131)
12
12
 
13
13
  Plugin to restore readability metadata after HAST to MDAST conversion.
14
14
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@isdk/mdast-plus",
3
3
  "description": "A semantic-first Markdown processing toolkit based on unified, remark, and rehype with a Fluent API and staged plugin system.",
4
- "version": "0.2.2",
4
+ "version": "0.2.3",
5
5
  "license": "MIT",
6
6
  "author": "Riceball LEE <snowyu.lee@gmail.com>",
7
7
  "homepage": "https://github.com/isdk/mdast-plus.js",