@isdk/mdast-plus 0.1.3 → 0.2.1

package/docs/interfaces/MdastPlugin.md

@@ -6,18 +6,50 @@
 
 # Interface: MdastPlugin
 
-Defined in: [packages/mdast-plus/src/types.ts:33](https://github.com/isdk/mdast-plus.js/blob/bacb4922529058fef775e3f4b4e71c98ac1cab17/src/types.ts#L33)
+Defined in: [packages/mdast-plus/src/types.ts:33](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L33)
 
 Configuration for a plugin within the mdast-plus pipeline.
 It wraps a standard unified plugin with execution metadata.
 
 ## Properties
 
+### after?
+
+> `optional` **after**: `string`
+
+Defined in: [packages/mdast-plus/src/types.ts:60](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L60)
+
+Run this plugin after the named plugin (within the same stage).
+
+***
+
+### before?
+
+> `optional` **before**: `string`
+
+Defined in: [packages/mdast-plus/src/types.ts:58](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L58)
+
+Run this plugin before the named plugin (within the same stage).
+
+***
+
+### main?
+
+> `optional` **main**: `boolean`
+
+Defined in: [packages/mdast-plus/src/types.ts:56](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L56)
+
+If true, this plugin is considered the "main" plugin for its stage.
+When multiple plugins exist in the same stage, a 'main' plugin will
+replace the default (first) plugin of that stage.
+
+***
+
 ### name?
 
 > `optional` **name**: `string`
 
-Defined in: [packages/mdast-plus/src/types.ts:39](https://github.com/isdk/mdast-plus.js/blob/bacb4922529058fef775e3f4b4e71c98ac1cab17/src/types.ts#L39)
+Defined in: [packages/mdast-plus/src/types.ts:39](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L39)
 
 Optional name for the plugin.
 Used for identification in overrides and logging.
@@ -29,7 +61,7 @@ If not provided, defaults to the plugin function's name.
 
 > `optional` **options**: `any`[]
 
-Defined in: [packages/mdast-plus/src/types.ts:46](https://github.com/isdk/mdast-plus.js/blob/bacb4922529058fef775e3f4b4e71c98ac1cab17/src/types.ts#L46)
+Defined in: [packages/mdast-plus/src/types.ts:46](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L46)
 
 Arguments passed to the plugin.
 MUST be an array of arguments (e.g., [optionsObject]).
@@ -40,7 +72,7 @@ MUST be an array of arguments (e.g., [optionsObject]).
 
 > `optional` **order**: `number`
 
-Defined in: [packages/mdast-plus/src/types.ts:50](https://github.com/isdk/mdast-plus.js/blob/bacb4922529058fef775e3f4b4e71c98ac1cab17/src/types.ts#L50)
+Defined in: [packages/mdast-plus/src/types.ts:50](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L50)
 
 Execution priority within the same stage. Lower values run earlier.
 
@@ -50,7 +82,7 @@ Execution priority within the same stage. Lower values run earlier.
 
 > **plugin**: `Plugin`\<`any`[], `any`, `any`\>
 
-Defined in: [packages/mdast-plus/src/types.ts:41](https://github.com/isdk/mdast-plus.js/blob/bacb4922529058fef775e3f4b4e71c98ac1cab17/src/types.ts#L41)
+Defined in: [packages/mdast-plus/src/types.ts:41](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L41)
 
 The standard unified plugin (attacher) function.
 
@@ -60,6 +92,6 @@ The standard unified plugin (attacher) function.
 
 > `optional` **stage**: [`PipelineStage`](../enumerations/PipelineStage.md) \| `"parse"` \| `"normalize"` \| `"compile"` \| `"finalize"` \| `"stringify"`
 
-Defined in: [packages/mdast-plus/src/types.ts:48](https://github.com/isdk/mdast-plus.js/blob/bacb4922529058fef775e3f4b4e71c98ac1cab17/src/types.ts#L48)
+Defined in: [packages/mdast-plus/src/types.ts:48](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L48)
 
 The stage in which this plugin should run.

package/docs/interfaces/MdastSub.md

@@ -6,7 +6,7 @@
 
 # Interface: MdastSub
 
-Defined in: [packages/mdast-plus/src/types.ts:93](https://github.com/isdk/mdast-plus.js/blob/bacb4922529058fef775e3f4b4e71c98ac1cab17/src/types.ts#L93)
+Defined in: [packages/mdast-plus/src/types.ts:103](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L103)
 
 Represents a subscript text node in mdast.
 
@@ -20,7 +20,7 @@ Represents a subscript text node in mdast.
 
 > **children**: `PhrasingContent`[]
 
-Defined in: [packages/mdast-plus/src/types.ts:95](https://github.com/isdk/mdast-plus.js/blob/bacb4922529058fef775e3f4b4e71c98ac1cab17/src/types.ts#L95)
+Defined in: [packages/mdast-plus/src/types.ts:105](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L105)
 
 List of children.
 
@@ -65,7 +65,7 @@ have a position.
 
 > **type**: `"sub"`
 
-Defined in: [packages/mdast-plus/src/types.ts:94](https://github.com/isdk/mdast-plus.js/blob/bacb4922529058fef775e3f4b4e71c98ac1cab17/src/types.ts#L94)
+Defined in: [packages/mdast-plus/src/types.ts:104](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L104)
 
 Node type.
 

package/docs/interfaces/MdastSup.md

@@ -6,7 +6,7 @@
 
 # Interface: MdastSup
 
-Defined in: [packages/mdast-plus/src/types.ts:99](https://github.com/isdk/mdast-plus.js/blob/bacb4922529058fef775e3f4b4e71c98ac1cab17/src/types.ts#L99)
+Defined in: [packages/mdast-plus/src/types.ts:109](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L109)
 
 Represents a superscript text node in mdast.
 
@@ -20,7 +20,7 @@ Represents a superscript text node in mdast.
 
 > **children**: `PhrasingContent`[]
 
-Defined in: [packages/mdast-plus/src/types.ts:101](https://github.com/isdk/mdast-plus.js/blob/bacb4922529058fef775e3f4b4e71c98ac1cab17/src/types.ts#L101)
+Defined in: [packages/mdast-plus/src/types.ts:111](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L111)
 
 List of children.
 
@@ -65,7 +65,7 @@ have a position.
 
 > **type**: `"sup"`
 
-Defined in: [packages/mdast-plus/src/types.ts:100](https://github.com/isdk/mdast-plus.js/blob/bacb4922529058fef775e3f4b4e71c98ac1cab17/src/types.ts#L100)
+Defined in: [packages/mdast-plus/src/types.ts:110](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L110)
 
 Node type.
 

package/docs/interfaces/ReadabilityOptions.md

@@ -0,0 +1,41 @@
+[**@isdk/mdast-plus**](../README.md)
+
+***
+
+[@isdk/mdast-plus](../globals.md) / ReadabilityOptions
+
+# Interface: ReadabilityOptions
+
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:6](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/plugins/html-readability.ts#L6)
+
+## Properties
+
+### jsdom?
+
+> `optional` **jsdom**: `Record`\<`string`, `any`\>
+
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:10](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/plugins/html-readability.ts#L10)
+
+***
+
+### readability?
+
+> `optional` **readability**: `false` \| `Record`\<`string`, `any`\>
+
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:9](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/plugins/html-readability.ts#L9)
+
+***
+
+### rehype-parse?
+
+> `optional` **rehype-parse**: `Record`\<`string`, `any`\>
+
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:11](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/plugins/html-readability.ts#L11)
+
+***
+
+### url?
+
+> `optional` **url**: `string`
+
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:8](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/plugins/html-readability.ts#L8)

package/docs/type-aliases/PipelineStageName.md

@@ -8,6 +8,6 @@
 
 > **PipelineStageName** = keyof *typeof* [`PipelineStage`](../enumerations/PipelineStage.md)
 
-Defined in: [packages/mdast-plus/src/types.ts:27](https://github.com/isdk/mdast-plus.js/blob/bacb4922529058fef775e3f4b4e71c98ac1cab17/src/types.ts#L27)
+Defined in: [packages/mdast-plus/src/types.ts:27](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L27)
 
 String names corresponding to the PipelineStage levels.

package/docs/variables/DefaultPipelineStage.md

@@ -8,6 +8,6 @@
 
 > `const` **DefaultPipelineStage**: [`compile`](../enumerations/PipelineStage.md#compile) = `PipelineStage.compile`
 
-Defined in: [packages/mdast-plus/src/types.ts:24](https://github.com/isdk/mdast-plus.js/blob/bacb4922529058fef775e3f4b4e71c98ac1cab17/src/types.ts#L24)
+Defined in: [packages/mdast-plus/src/types.ts:24](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/types.ts#L24)
 
 The default stage assigned to a plugin if none is specified.

package/docs/variables/astFormat.md

@@ -8,7 +8,7 @@
 
 > `const` **astFormat**: [`MdastFormat`](../interfaces/MdastFormat.md)
 
-Defined in: [packages/mdast-plus/src/formats/ast.ts:35](https://github.com/isdk/mdast-plus.js/blob/bacb4922529058fef775e3f4b4e71c98ac1cab17/src/formats/ast.ts#L35)
+Defined in: [packages/mdast-plus/src/formats/ast.ts:35](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/formats/ast.ts#L35)
 
 AST (MDAST) format definition.
 Supports reading from JSON strings and provides full normalization

package/docs/variables/htmlFormat.md

@@ -8,7 +8,7 @@
 
 > `const` **htmlFormat**: [`MdastFormat`](../interfaces/MdastFormat.md)
 
-Defined in: [packages/mdast-plus/src/formats/html.ts:70](https://github.com/isdk/mdast-plus.js/blob/bacb4922529058fef775e3f4b4e71c98ac1cab17/src/formats/html.ts#L70)
+Defined in: [packages/mdast-plus/src/formats/html.ts:71](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/formats/html.ts#L71)
 
 HTML format definition.
 

package/docs/variables/htmlReadability.md

@@ -0,0 +1,13 @@
+[**@isdk/mdast-plus**](../README.md)
+
+***
+
+[@isdk/mdast-plus](../globals.md) / htmlReadability
+
+# Variable: htmlReadability
+
+> `const` **htmlReadability**: `Plugin`\<\[[`ReadabilityOptions`](../interfaces/ReadabilityOptions.md)?\], `string`, `Root`\>
+
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:17](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/plugins/html-readability.ts#L17)
+
+A unified/rehype plugin that uses Mozilla's Readability to parse the input HTML.

package/docs/variables/htmlReadabilityPlugin.md

@@ -0,0 +1,31 @@
+[**@isdk/mdast-plus**](../README.md)
+
+***
+
+[@isdk/mdast-plus](../globals.md) / htmlReadabilityPlugin
+
+# Variable: htmlReadabilityPlugin
+
+> `const` **htmlReadabilityPlugin**: `object`
+
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:79](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/plugins/html-readability.ts#L79)
+
+Pre-configured MdastPlugin for html-readability.
+
+## Type Declaration
+
+### main
+
+> **main**: `boolean` = `true`
+
+### name
+
+> **name**: `string` = `'readability'`
+
+### plugin
+
+> **plugin**: `Plugin`\<\[[`ReadabilityOptions`](../interfaces/ReadabilityOptions.md)?\], `string`, `Root`\> = `htmlReadability`
+
+### stage
+
+> **stage**: [`PipelineStage`](../enumerations/PipelineStage.md) = `PipelineStage.parse`

package/docs/variables/htmlReadabilityPlugins.md

@@ -0,0 +1,13 @@
+[**@isdk/mdast-plus**](../README.md)
+
+***
+
+[@isdk/mdast-plus](../globals.md) / htmlReadabilityPlugins
+
+# Variable: htmlReadabilityPlugins
+
+> `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); \})[]
+
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:106](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/plugins/html-readability.ts#L106)
+
+Combined plugins for HTML readability.

package/docs/variables/markdownFormat.md

@@ -8,7 +8,7 @@
 
 > `const` **markdownFormat**: [`MdastFormat`](../interfaces/MdastFormat.md)
 
-Defined in: [packages/mdast-plus/src/formats/markdown.ts:103](https://github.com/isdk/mdast-plus.js/blob/bacb4922529058fef775e3f4b4e71c98ac1cab17/src/formats/markdown.ts#L103)
+Defined in: [packages/mdast-plus/src/formats/markdown.ts:103](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/formats/markdown.ts#L103)
 
 Markdown format definition.
 

package/docs/variables/restoreReadabilityMetaPlugin.md

@@ -0,0 +1,49 @@
+[**@isdk/mdast-plus**](../README.md)
+
+***
+
+[@isdk/mdast-plus](../globals.md) / restoreReadabilityMetaPlugin
+
+# Variable: restoreReadabilityMetaPlugin
+
+> `const` **restoreReadabilityMetaPlugin**: `object`
+
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:91](https://github.com/isdk/mdast-plus.js/blob/becb4bdeb4b577bd75c7751367751e84056ff87e/src/plugins/html-readability.ts#L91)
+
+Plugin to restore readability metadata after HAST to MDAST conversion.
+
+## Type Declaration
+
+### after
+
+> **after**: `string` = `'rehype-remark'`
+
+### name
+
+> **name**: `string` = `'restore-readability-meta'`
+
+### plugin()
+
+> **plugin**: () => (`tree`, `file`) => `void`
+
+#### Returns
+
+> (`tree`, `file`): `void`
+
+##### Parameters
+
+###### tree
+
+`any`
+
+###### file
+
+`any`
+
+##### Returns
+
+`void`
+
+### stage
+
+> **stage**: [`PipelineStage`](../enumerations/PipelineStage.md) = `PipelineStage.parse`

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@isdk/mdast-plus",
   "description": "A semantic-first Markdown processing toolkit based on unified, remark, and rehype with a Fluent API and staged plugin system.",
-  "version": "0.1.3",
+  "version": "0.2.1",
   "license": "MIT",
   "author": "Riceball LEE <snowyu.lee@gmail.com>",
   "homepage": "https://github.com/isdk/mdast-plus.js",
@@ -22,8 +22,11 @@
     }
   },
   "dependencies": {
+    "@mozilla/readability": "^0.6.0",
     "ajv": "^8.17.1",
     "ajv-formats": "^3.0.1",
+    "hast-util-from-dom": "^5.0.1",
+    "hast-util-from-html": "^2.0.3",
     "hast-util-to-mdast": "^10.1.2",
     "lodash-es": "^4.17.22",
     "mdast-util-directive": "^3.1.0",
@@ -49,6 +52,9 @@
     "vfile": "^6.0.3",
     "yaml": "^2.8.2"
   },
+  "peerDependencies": {
+    "jsdom": "^27.3.0"
+  },
   "devDependencies": {
     "@antfu/eslint-config": "^4.10.1",
     "@apidevtools/json-schema-ref-parser": "^15.1.3",
@@ -63,6 +69,7 @@
     "eslint": "^9.34.0",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-tsdoc": "^0.4.0",
+    "jsdom": "^27.3.0",
     "json-schema-to-typescript": "^15.0.4",
     "prettier": "^3.6.2",
     "terser": "^5.44.0",