@isdk/mdast-plus 0.2.3 → 0.3.0

package/docs/interfaces/MdastFormat.md

@@ -6,7 +6,7 @@
 
 # Interface: MdastFormat
 
-Defined in: [packages/mdast-plus/src/types.ts:66](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L66)
+Defined in: [packages/mdast-plus/src/types.ts:66](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L66)
 
 Defines a document format, encompassing its input (parsing) and output (serialization) strategies.
 
@@ -16,7 +16,7 @@ Defines a document format, encompassing its input (parsing) and output (serializ
 
 > `optional` **extensions**: `string`[]
 
-Defined in: [packages/mdast-plus/src/types.ts:72](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L72)
+Defined in: [packages/mdast-plus/src/types.ts:72](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L72)
 
 File extensions associated with this format.
 
@@ -26,7 +26,7 @@ File extensions associated with this format.
 
 > **id**: `string`
 
-Defined in: [packages/mdast-plus/src/types.ts:68](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L68)
+Defined in: [packages/mdast-plus/src/types.ts:68](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L68)
 
 Unique identifier for the format (e.g., 'markdown', 'html').
 
@@ -36,7 +36,7 @@ Unique identifier for the format (e.g., 'markdown', 'html').
 
 > `optional` **input**: [`MdastPlugin`](MdastPlugin.md)[]
 
-Defined in: [packages/mdast-plus/src/types.ts:77](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L77)
+Defined in: [packages/mdast-plus/src/types.ts:77](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L77)
 
 Plugins used for reading this format into a standard AST (Parser + Normalizer).
 
@@ -46,7 +46,7 @@ Plugins used for reading this format into a standard AST (Parser + Normalizer).
 
 > `optional` **mediaTypes**: `string`[]
 
-Defined in: [packages/mdast-plus/src/types.ts:74](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L74)
+Defined in: [packages/mdast-plus/src/types.ts:74](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L74)
 
 MIME types associated with this format.
 
@@ -56,7 +56,7 @@ MIME types associated with this format.
 
 > `optional` **output**: [`MdastPlugin`](MdastPlugin.md)[]
 
-Defined in: [packages/mdast-plus/src/types.ts:80](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L80)
+Defined in: [packages/mdast-plus/src/types.ts:80](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L80)
 
 Plugins used for serializing the AST into this format (Finalizer + Stringifier).
 
@@ -66,6 +66,6 @@ Plugins used for serializing the AST into this format (Finalizer + Stringifier).
 
 > `optional` **title**: `string`
 
-Defined in: [packages/mdast-plus/src/types.ts:70](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L70)
+Defined in: [packages/mdast-plus/src/types.ts:70](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L70)
 
 Human-readable title.

package/docs/interfaces/MdastMark.md

@@ -6,7 +6,7 @@
 
 # Interface: MdastMark
 
-Defined in: [packages/mdast-plus/src/types.ts:118](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L118)
+Defined in: [packages/mdast-plus/src/types.ts:118](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L118)
 
 Represents a highlighted text (mark) node in mdast.
 
@@ -20,7 +20,7 @@ Represents a highlighted text (mark) node in mdast.
 
 > **children**: `PhrasingContent`[]
 
-Defined in: [packages/mdast-plus/src/types.ts:120](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L120)
+Defined in: [packages/mdast-plus/src/types.ts:120](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L120)
 
 List of children.
 
@@ -65,7 +65,7 @@ have a position.
 
 > **type**: `"mark"`
 
-Defined in: [packages/mdast-plus/src/types.ts:119](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L119)
+Defined in: [packages/mdast-plus/src/types.ts:119](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L119)
 
 Node type.
 

package/docs/interfaces/MdastPlugin.md

@@ -6,7 +6,7 @@
 
 # Interface: MdastPlugin
 
-Defined in: [packages/mdast-plus/src/types.ts:33](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L33)
+Defined in: [packages/mdast-plus/src/types.ts:33](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L33)
 
 Configuration for a plugin within the mdast-plus pipeline.
 It wraps a standard unified plugin with execution metadata.
@@ -17,7 +17,7 @@ It wraps a standard unified plugin with execution metadata.
 
 > `optional` **after**: `string`
 
-Defined in: [packages/mdast-plus/src/types.ts:60](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L60)
+Defined in: [packages/mdast-plus/src/types.ts:60](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L60)
 
 Run this plugin after the named plugin (within the same stage).
 
@@ -27,7 +27,7 @@ Run this plugin after the named plugin (within the same stage).
 
 > `optional` **before**: `string`
 
-Defined in: [packages/mdast-plus/src/types.ts:58](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L58)
+Defined in: [packages/mdast-plus/src/types.ts:58](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L58)
 
 Run this plugin before the named plugin (within the same stage).
 
@@ -37,7 +37,7 @@ Run this plugin before the named plugin (within the same stage).
 
 > `optional` **main**: `boolean`
 
-Defined in: [packages/mdast-plus/src/types.ts:56](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L56)
+Defined in: [packages/mdast-plus/src/types.ts:56](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/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
@@ -49,7 +49,7 @@ replace the default (first) plugin of that stage.
 
 > `optional` **name**: `string`
 
-Defined in: [packages/mdast-plus/src/types.ts:39](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L39)
+Defined in: [packages/mdast-plus/src/types.ts:39](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L39)
 
 Optional name for the plugin.
 Used for identification in overrides and logging.
@@ -61,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/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L46)
+Defined in: [packages/mdast-plus/src/types.ts:46](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L46)
 
 Arguments passed to the plugin.
 MUST be an array of arguments (e.g., [optionsObject]).
@@ -72,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/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L50)
+Defined in: [packages/mdast-plus/src/types.ts:50](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L50)
 
 Execution priority within the same stage. Lower values run earlier.
 
@@ -82,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/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L41)
+Defined in: [packages/mdast-plus/src/types.ts:41](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L41)
 
 The standard unified plugin (attacher) function.
 
@@ -92,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/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L48)
+Defined in: [packages/mdast-plus/src/types.ts:48](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/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:124](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L124)
+Defined in: [packages/mdast-plus/src/types.ts:124](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L124)
 
 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:126](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L126)
+Defined in: [packages/mdast-plus/src/types.ts:126](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L126)
 
 List of children.
 
@@ -65,7 +65,7 @@ have a position.
 
 > **type**: `"sub"`
 
-Defined in: [packages/mdast-plus/src/types.ts:125](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L125)
+Defined in: [packages/mdast-plus/src/types.ts:125](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L125)
 
 Node type.
 

package/docs/interfaces/MdastSup.md

@@ -6,7 +6,7 @@
 
 # Interface: MdastSup
 
-Defined in: [packages/mdast-plus/src/types.ts:130](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L130)
+Defined in: [packages/mdast-plus/src/types.ts:130](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L130)
 
 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:132](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L132)
+Defined in: [packages/mdast-plus/src/types.ts:132](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L132)
 
 List of children.
 
@@ -65,7 +65,7 @@ have a position.
 
 > **type**: `"sup"`
 
-Defined in: [packages/mdast-plus/src/types.ts:131](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L131)
+Defined in: [packages/mdast-plus/src/types.ts:131](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L131)
 
 Node type.
 

package/docs/interfaces/PipelineRunOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: PipelineRunOptions
 
-Defined in: [packages/mdast-plus/src/types.ts:86](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L86)
+Defined in: [packages/mdast-plus/src/types.ts:86](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L86)
 
 Options for controlling the pipeline execution.
 
@@ -16,7 +16,7 @@ Options for controlling the pipeline execution.
 
 > `optional` **overrides**: `Record`\<`string`, `any`\>
 
-Defined in: [packages/mdast-plus/src/types.ts:101](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L101)
+Defined in: [packages/mdast-plus/src/types.ts:101](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L101)
 
 Map of plugin names to their option overrides.
 
@@ -26,7 +26,7 @@ Map of plugin names to their option overrides.
 
 > `optional` **stage**: [`PipelineStage`](../enumerations/PipelineStage.md) \| `"parse"` \| `"normalize"` \| `"compile"` \| `"finalize"` \| `"stringify"`
 
-Defined in: [packages/mdast-plus/src/types.ts:91](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L91)
+Defined in: [packages/mdast-plus/src/types.ts:91](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L91)
 
 Run the pipeline only up to the specified stage.
 Useful for debugging or inspecting intermediate ASTs.
@@ -37,7 +37,7 @@ Useful for debugging or inspecting intermediate ASTs.
 
 > `optional` **stopAtIndex**: `number`
 
-Defined in: [packages/mdast-plus/src/types.ts:97](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L97)
+Defined in: [packages/mdast-plus/src/types.ts:97](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/types.ts#L97)
 
 If `stage` is specified, stop execution at this index (0-based)
 within the list of plugins at that stage.

package/docs/interfaces/ReadabilityOptions.md

@@ -6,15 +6,43 @@
 
 # Interface: ReadabilityOptions
 
-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)
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:25](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/plugins/html-readability.ts#L25)
 
 ## Properties
 
+### fields?
+
+> `optional` **fields**: `string`[] \| `Record`\<`string`, `string`\>
+
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:53](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/plugins/html-readability.ts#L53)
+
+Control the fields and names in metadata.
+- If an array of strings, it acts as an allowlist (only these fields are kept).
+- If an object, it maps original field names to new names. Only the keys present in the map are kept (Projection).
+
+***
+
+### frontmatter?
+
+> `optional` **frontmatter**: `boolean` \| `"yaml"` \| `"toml"`
+
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:36](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/plugins/html-readability.ts#L36)
+
+Whether to inject metadata as frontmatter.
+
+#### Default
+
+```ts
+false
+```
+
+***
+
 ### hast?
 
 > `optional` **hast**: `Record`\<`string`, `any`\>
 
-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)
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:30](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/plugins/html-readability.ts#L30)
 
 ***
 
@@ -22,7 +50,7 @@ Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:12](https://git
 
 > `optional` **jsdom**: `Record`\<`string`, `any`\>
 
-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)
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:29](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/plugins/html-readability.ts#L29)
 
 ***
 
@@ -30,7 +58,7 @@ Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:11](https://git
 
 > `optional` **readability**: `false` \| `Record`\<`string`, `any`\>
 
-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)
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:28](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/plugins/html-readability.ts#L28)
 
 ***
 
@@ -38,7 +66,40 @@ Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:10](https://git
 
 > `optional` **rehype-parse**: `Record`\<`string`, `any`\>
 
-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)
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:31](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/plugins/html-readability.ts#L31)
+
+***
+
+### smartExcerpt?
+
+> `optional` **smartExcerpt**: `boolean` \| [`SmartExcerptOptions`](SmartExcerptOptions.md)
+
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:47](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/plugins/html-readability.ts#L47)
+
+Whether to remove the excerpt if it is a duplicate or near-duplicate of the main content.
+Useful when the content is short or the excerpt is just a subset of the content.
+
+#### Default
+
+```ts
+true
+```
+
+***
+
+### sourceLink?
+
+> `optional` **sourceLink**: `boolean`
+
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:41](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/plugins/html-readability.ts#L41)
+
+Whether to append source link at the bottom.
+
+#### Default
+
+```ts
+false
+```
 
 ***
 
@@ -46,4 +107,4 @@ Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:13](https://git
 
 > `optional` **url**: `string`
 
-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)
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:27](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/plugins/html-readability.ts#L27)

package/docs/interfaces/SmartExcerptOptions.md

@@ -0,0 +1,43 @@
+[**@isdk/mdast-plus**](../README.md)
+
+***
+
+[@isdk/mdast-plus](../globals.md) / SmartExcerptOptions
+
+# Interface: SmartExcerptOptions
+
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:10](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/plugins/html-readability.ts#L10)
+
+## Properties
+
+### minContentLength?
+
+> `optional` **minContentLength**: `number`
+
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:22](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/plugins/html-readability.ts#L22)
+
+The minimum length of the main content required to keep the excerpt.
+If content length is less than this value, the excerpt is considered redundant (if it is contained in the content).
+
+#### Default
+
+```ts
+300
+```
+
+***
+
+### threshold?
+
+> `optional` **threshold**: `number`
+
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:16](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/plugins/html-readability.ts#L16)
+
+The threshold ratio of excerpt length to content length.
+If (excerptLength / contentLength) > threshold, the excerpt is considered redundant.
+
+#### Default
+
+```ts
+0.6
+```

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/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L27)
+Defined in: [packages/mdast-plus/src/types.ts:27](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/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/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/types.ts#L24)
+Defined in: [packages/mdast-plus/src/types.ts:24](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/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/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/formats/ast.ts#L35)
+Defined in: [packages/mdast-plus/src/formats/ast.ts:35](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/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:71](https://github.com/isdk/mdast-plus.js/blob/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/formats/html.ts#L71)
+Defined in: [packages/mdast-plus/src/formats/html.ts:71](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/formats/html.ts#L71)
 
 HTML format definition.
 

package/docs/variables/htmlReadability.md

@@ -8,6 +8,6 @@
 
 > `const` **htmlReadability**: `Plugin`\<\[[`ReadabilityOptions`](../interfaces/ReadabilityOptions.md)?\], `string`, `Root`\>
 
-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)
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:59](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/plugins/html-readability.ts#L59)
 
 A unified/rehype plugin that uses Mozilla's Readability to parse the input HTML.

package/docs/variables/htmlReadabilityPlugin.md

@@ -8,7 +8,7 @@
 
 > `const` **htmlReadabilityPlugin**: `object`
 
-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)
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:218](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/plugins/html-readability.ts#L218)
 
 Pre-configured MdastPlugin for html-readability.
 

package/docs/variables/htmlReadabilityPlugins.md

@@ -6,8 +6,8 @@
 
 # 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); \})[]
+> `const` **htmlReadabilityPlugins**: (\{ `main`: `boolean`; `name`: `string`; `plugin`: `Plugin`\<\[[`ReadabilityOptions`](../interfaces/ReadabilityOptions.md)?\], `string`, `Root`\>; `stage`: [`PipelineStage`](../enumerations/PipelineStage.md); \} \| \{ `after`: `string`; `name`: `string`; `plugin`: (`options?`) => (`tree`, `file`) => `void`; `stage`: [`PipelineStage`](../enumerations/PipelineStage.md); \})[]
 
-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)
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:277](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/plugins/html-readability.ts#L277)
 
 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/b08b74cf958d7f9ed7bee309acc7e659bc74da3c/src/formats/markdown.ts#L103)
+Defined in: [packages/mdast-plus/src/formats/markdown.ts:103](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/formats/markdown.ts#L103)
 
 Markdown format definition.
 

package/docs/variables/restoreReadabilityMetaPlugin.md

@@ -8,7 +8,7 @@
 
 > `const` **restoreReadabilityMetaPlugin**: `object`
 
-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)
+Defined in: [packages/mdast-plus/src/plugins/html-readability.ts:230](https://github.com/isdk/mdast-plus.js/blob/fc889343b0a625d8edbf2036c3e25b676d1bf163/src/plugins/html-readability.ts#L230)
 
 Plugin to restore readability metadata after HAST to MDAST conversion.
 
@@ -24,7 +24,13 @@ Plugin to restore readability metadata after HAST to MDAST conversion.
 
 ### plugin()
 
-> **plugin**: () => (`tree`, `file`) => `void`
+> **plugin**: (`options?`) => (`tree`, `file`) => `void`
+
+#### Parameters
+
+##### options?
+
+[`ReadabilityOptions`](../interfaces/ReadabilityOptions.md)
 
 #### Returns
 

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.2.3",
+  "version": "0.3.0",
   "license": "MIT",
   "author": "Riceball LEE <snowyu.lee@gmail.com>",
   "homepage": "https://github.com/isdk/mdast-plus.js",