siMarkdownDirective Type documentation¶

Function

Installs component rendering for directives parsed by remark-directive .

Parameters
directives: `ReadonlyMap`<`string`, `TypeHandler`>¶

An extension to the si-markdown component

Properties
Special code type handlers to install codeTypes?: `TypeHandler`[]¶
Directives directives?: `TypeHandler`[]¶
`unified` plugins to install plugins?: `PluginWithOptions`[]¶
Type handlers to install types?: `TypeHandler`[]¶

Type handler for a named type. This can be an AST node type, a code type, a directive name

Properties
The component used to render the node component: `Type`<`SiMarkdownExtensionComponent`> from `component`¶
Options passed to the component options?: `any` from `options`¶
Type name type: `string`¶

Combination of unified plugin with options

Properties
Options passed during plugin registration options?: `any`¶
The plugin plugin: `UnifiedPlugin`¶

<T>¶

A combination of a component and options passed to it during run-time

Properties
The component used to render the node component: `Type`<`T`>¶
Options passed to the component options?: `any`¶

Interface an extension component must implement

Properties
Node to be rendered node: `InputSignal`<`Node`>¶
Options passed to the component options: `InputSignal`<`any`>¶
The parent node parent: `InputSignal`<`Parent`>¶

component `Type`<`T`>¶ Property The component used to render the node

options? `any`¶ Property Options passed to the component

UnifiedPlugin (`Plugin`<`any`> \| `Transformer`<`any`> \| `Preset` \| `PluggableList`)¶ Type alias

Node ¶ import imported from @types/mdast

Parent ¶ import imported from @types/mdast

Plugin ¶ import imported from unified

Transformer ¶ import imported from unified

Preset ¶ import imported from unified

PluggableList ¶ import imported from unified

Except where otherwise noted, content on this site is licensed under MIT License.