@isdk/mdast-plus 0.1.1

package/docs/interfaces/ConvertResult.md

@@ -0,0 +1,39 @@
+[**@isdk/mdast-plus**](../README.md)
+
+***
+
+[@isdk/mdast-plus](../globals.md) / ConvertResult
+
+# Interface: ConvertResult\<T\>
+
+Defined in: [packages/mdast-plus/src/types.ts:50](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L50)
+
+Result of a conversion process.
+
+## Type Parameters
+
+### T
+
+`T` = `string`
+
+The type of the main content (default: string)
+
+## Properties
+
+### assets
+
+> **assets**: [`MdastAsset`](MdastAsset.md)[]
+
+Defined in: [packages/mdast-plus/src/types.ts:54](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L54)
+
+Extracted assets
+
+***
+
+### content
+
+> **content**: `T`
+
+Defined in: [packages/mdast-plus/src/types.ts:52](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L52)
+
+The converted content

package/docs/interfaces/MdastAsset.md

@@ -0,0 +1,41 @@
+[**@isdk/mdast-plus**](../README.md)
+
+***
+
+[@isdk/mdast-plus](../globals.md) / MdastAsset
+
+# Interface: MdastAsset
+
+Defined in: [packages/mdast-plus/src/types.ts:37](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L37)
+
+Represents an asset (e.g., image) extracted during processing.
+
+## Properties
+
+### bytes
+
+> **bytes**: `Uint8Array`
+
+Defined in: [packages/mdast-plus/src/types.ts:43](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L43)
+
+Raw content as bytes
+
+***
+
+### contentType
+
+> **contentType**: `string`
+
+Defined in: [packages/mdast-plus/src/types.ts:41](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L41)
+
+MIME type of the asset
+
+***
+
+### path
+
+> **path**: `string`
+
+Defined in: [packages/mdast-plus/src/types.ts:39](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L39)
+
+Relative path or identifier for the asset

package/docs/interfaces/MdastDataOrigin.md

@@ -0,0 +1,45 @@
+[**@isdk/mdast-plus**](../README.md)
+
+***
+
+[@isdk/mdast-plus](../globals.md) / MdastDataOrigin
+
+# Interface: MdastDataOrigin
+
+Defined in: [packages/mdast-plus/src/types.ts:60](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L60)
+
+Original metadata for a node.
+
+## Indexable
+
+\[`k`: `string`\]: `unknown`
+
+## Properties
+
+### format
+
+> **format**: `string`
+
+Defined in: [packages/mdast-plus/src/types.ts:62](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L62)
+
+Source format
+
+***
+
+### hash?
+
+> `optional` **hash**: `string`
+
+Defined in: [packages/mdast-plus/src/types.ts:66](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L66)
+
+Hash of the source content
+
+***
+
+### raw?
+
+> `optional` **raw**: `unknown`
+
+Defined in: [packages/mdast-plus/src/types.ts:64](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L64)
+
+Raw data from the source

package/docs/interfaces/MdastFormatDefinition.md

@@ -0,0 +1,51 @@
+[**@isdk/mdast-plus**](../README.md)
+
+***
+
+[@isdk/mdast-plus](../globals.md) / MdastFormatDefinition
+
+# Interface: MdastFormatDefinition
+
+Defined in: [packages/mdast-plus/src/types.ts:27](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L27)
+
+Definition for an mdast format (parser/stringifier).
+
+## Properties
+
+### parse()?
+
+> `optional` **parse**: (`processor`) => `void`
+
+Defined in: [packages/mdast-plus/src/types.ts:29](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L29)
+
+Function to register parser plugins
+
+#### Parameters
+
+##### processor
+
+`any`
+
+#### Returns
+
+`void`
+
+***
+
+### stringify()?
+
+> `optional` **stringify**: (`processor`) => `void`
+
+Defined in: [packages/mdast-plus/src/types.ts:31](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L31)
+
+Function to register stringifier plugins
+
+#### Parameters
+
+##### processor
+
+`any`
+
+#### Returns
+
+`void`

package/docs/interfaces/MdastMark.md

@@ -0,0 +1,74 @@
+[**@isdk/mdast-plus**](../README.md)
+
+***
+
+[@isdk/mdast-plus](../globals.md) / MdastMark
+
+# Interface: MdastMark
+
+Defined in: [packages/mdast-plus/src/types.ts:73](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L73)
+
+mdast node for highlighted text (mark).
+
+## Extends
+
+- `Parent`
+
+## Properties
+
+### children
+
+> **children**: `PhrasingContent`[]
+
+Defined in: [packages/mdast-plus/src/types.ts:75](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L75)
+
+List of children.
+
+#### Overrides
+
+`UnistParent.children`
+
+***
+
+### data?
+
+> `optional` **data**: `Data`
+
+Defined in: node\_modules/.pnpm/@types+unist@3.0.3/node\_modules/@types/unist/index.d.ts:95
+
+Info from the ecosystem.
+
+#### Inherited from
+
+`UnistParent.data`
+
+***
+
+### position?
+
+> `optional` **position**: `Position`
+
+Defined in: node\_modules/.pnpm/@types+unist@3.0.3/node\_modules/@types/unist/index.d.ts:103
+
+Position of a node in a source document.
+
+Nodes that are generated (not in the original source document) must not
+have a position.
+
+#### Inherited from
+
+`UnistParent.position`
+
+***
+
+### type
+
+> **type**: `"mark"`
+
+Defined in: [packages/mdast-plus/src/types.ts:74](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L74)
+
+Node type.
+
+#### Overrides
+
+`UnistParent.type`

package/docs/interfaces/MdastPlugin.md

@@ -0,0 +1,65 @@
+[**@isdk/mdast-plus**](../README.md)
+
+***
+
+[@isdk/mdast-plus](../globals.md) / MdastPlugin
+
+# Interface: MdastPlugin
+
+Defined in: [packages/mdast-plus/src/types.ts:13](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L13)
+
+Definition for an mdast plugin.
+
+## Properties
+
+### name
+
+> **name**: `string`
+
+Defined in: [packages/mdast-plus/src/types.ts:15](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L15)
+
+Plugin name
+
+***
+
+### order?
+
+> `optional` **order**: `number`
+
+Defined in: [packages/mdast-plus/src/types.ts:19](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L19)
+
+Execution order within the stage (lower numbers run first)
+
+***
+
+### stage?
+
+> `optional` **stage**: [`Stage`](../type-aliases/Stage.md)
+
+Defined in: [packages/mdast-plus/src/types.ts:17](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L17)
+
+Processing stage the plugin belongs to
+
+***
+
+### transform()
+
+> **transform**: (`tree`, `ctx`) => `void` \| `Promise`\<`void`\>
+
+Defined in: [packages/mdast-plus/src/types.ts:21](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L21)
+
+Transformation function
+
+#### Parameters
+
+##### tree
+
+`Root`
+
+##### ctx
+
+`any`
+
+#### Returns
+
+`void` \| `Promise`\<`void`\>

package/docs/interfaces/MdastReader.md

@@ -0,0 +1,41 @@
+[**@isdk/mdast-plus**](../README.md)
+
+***
+
+[@isdk/mdast-plus](../globals.md) / MdastReader
+
+# Interface: MdastReader\<I\>
+
+Defined in: [packages/mdast-plus/src/types.ts:131](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L131)
+
+Interface for reading input into an mdast tree.
+
+## Type Parameters
+
+### I
+
+`I`
+
+Input type
+
+## Methods
+
+### read()
+
+> **read**(`input`): `Promise`\<`Root`\>
+
+Defined in: [packages/mdast-plus/src/types.ts:136](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L136)
+
+Reads input and returns an mdast Root node.
+
+#### Parameters
+
+##### input
+
+`I`
+
+The input to read
+
+#### Returns
+
+`Promise`\<`Root`\>

package/docs/interfaces/MdastSub.md

@@ -0,0 +1,74 @@
+[**@isdk/mdast-plus**](../README.md)
+
+***
+
+[@isdk/mdast-plus](../globals.md) / MdastSub
+
+# Interface: MdastSub
+
+Defined in: [packages/mdast-plus/src/types.ts:81](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L81)
+
+mdast node for subscript text.
+
+## Extends
+
+- `Parent`
+
+## Properties
+
+### children
+
+> **children**: `PhrasingContent`[]
+
+Defined in: [packages/mdast-plus/src/types.ts:83](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L83)
+
+List of children.
+
+#### Overrides
+
+`UnistParent.children`
+
+***
+
+### data?
+
+> `optional` **data**: `Data`
+
+Defined in: node\_modules/.pnpm/@types+unist@3.0.3/node\_modules/@types/unist/index.d.ts:95
+
+Info from the ecosystem.
+
+#### Inherited from
+
+`UnistParent.data`
+
+***
+
+### position?
+
+> `optional` **position**: `Position`
+
+Defined in: node\_modules/.pnpm/@types+unist@3.0.3/node\_modules/@types/unist/index.d.ts:103
+
+Position of a node in a source document.
+
+Nodes that are generated (not in the original source document) must not
+have a position.
+
+#### Inherited from
+
+`UnistParent.position`
+
+***
+
+### type
+
+> **type**: `"sub"`
+
+Defined in: [packages/mdast-plus/src/types.ts:82](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L82)
+
+Node type.
+
+#### Overrides
+
+`UnistParent.type`

package/docs/interfaces/MdastSup.md

@@ -0,0 +1,74 @@
+[**@isdk/mdast-plus**](../README.md)
+
+***
+
+[@isdk/mdast-plus](../globals.md) / MdastSup
+
+# Interface: MdastSup
+
+Defined in: [packages/mdast-plus/src/types.ts:89](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L89)
+
+mdast node for superscript text.
+
+## Extends
+
+- `Parent`
+
+## Properties
+
+### children
+
+> **children**: `PhrasingContent`[]
+
+Defined in: [packages/mdast-plus/src/types.ts:91](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L91)
+
+List of children.
+
+#### Overrides
+
+`UnistParent.children`
+
+***
+
+### data?
+
+> `optional` **data**: `Data`
+
+Defined in: node\_modules/.pnpm/@types+unist@3.0.3/node\_modules/@types/unist/index.d.ts:95
+
+Info from the ecosystem.
+
+#### Inherited from
+
+`UnistParent.data`
+
+***
+
+### position?
+
+> `optional` **position**: `Position`
+
+Defined in: node\_modules/.pnpm/@types+unist@3.0.3/node\_modules/@types/unist/index.d.ts:103
+
+Position of a node in a source document.
+
+Nodes that are generated (not in the original source document) must not
+have a position.
+
+#### Inherited from
+
+`UnistParent.position`
+
+***
+
+### type
+
+> **type**: `"sup"`
+
+Defined in: [packages/mdast-plus/src/types.ts:90](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L90)
+
+Node type.
+
+#### Overrides
+
+`UnistParent.type`

package/docs/interfaces/MdastTransformer.md

@@ -0,0 +1,33 @@
+[**@isdk/mdast-plus**](../README.md)
+
+***
+
+[@isdk/mdast-plus](../globals.md) / MdastTransformer
+
+# Interface: MdastTransformer
+
+Defined in: [packages/mdast-plus/src/types.ts:142](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L142)
+
+Interface for transforming an mdast tree.
+
+## Methods
+
+### transform()
+
+> **transform**(`tree`): `Promise`\<\{ `assets?`: [`MdastAsset`](MdastAsset.md)[]; `tree`: `Root`; \}\>
+
+Defined in: [packages/mdast-plus/src/types.ts:147](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L147)
+
+Transforms the given mdast tree.
+
+#### Parameters
+
+##### tree
+
+`Root`
+
+The Root node to transform
+
+#### Returns
+
+`Promise`\<\{ `assets?`: [`MdastAsset`](MdastAsset.md)[]; `tree`: `Root`; \}\>

package/docs/interfaces/MdastWriter.md

@@ -0,0 +1,47 @@
+[**@isdk/mdast-plus**](../README.md)
+
+***
+
+[@isdk/mdast-plus](../globals.md) / MdastWriter
+
+# Interface: MdastWriter\<Output\>
+
+Defined in: [packages/mdast-plus/src/types.ts:154](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L154)
+
+Interface for writing an mdast tree to an output format.
+
+## Type Parameters
+
+### Output
+
+`Output` = `string`
+
+Output type (default: string)
+
+## Methods
+
+### write()
+
+> **write**(`tree`, `assets?`): `Promise`\<[`ConvertResult`](ConvertResult.md)\<`Output`\>\>
+
+Defined in: [packages/mdast-plus/src/types.ts:160](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L160)
+
+Writes the mdast tree to the target output.
+
+#### Parameters
+
+##### tree
+
+`Root`
+
+The Root node to write
+
+##### assets?
+
+[`MdastAsset`](MdastAsset.md)[]
+
+Optional assets to include
+
+#### Returns
+
+`Promise`\<[`ConvertResult`](ConvertResult.md)\<`Output`\>\>

package/docs/type-aliases/Stage.md

@@ -0,0 +1,13 @@
+[**@isdk/mdast-plus**](../README.md)
+
+***
+
+[@isdk/mdast-plus](../globals.md) / Stage
+
+# Type Alias: Stage
+
+> **Stage** = `"normalize"` \| `"compile"` \| `"finalize"`
+
+Defined in: [packages/mdast-plus/src/types.ts:8](https://github.com/isdk/mdast-plus.js/blob/c94d215035e579925cf60814f0a5c05c543ca784/src/types.ts#L8)
+
+Stages for mdast-plus pipeline processing.