Skip to content

Vizel API / core/src / VizelMarkdownItInstance

Interface: VizelMarkdownItInstance

Defined in: packages/core/src/markdown/types.ts:13

Minimal subset of the markdown-it parser instance that flavor plugins interact with at registration time.

Defined locally so consumers do not need @types/markdown-it installed to author a flavor plugin. markdownItPlugins callbacks receive the full markdown-it API — the structural type below covers the .use() registration that every plugin needs, and any narrower call is available via a (md as any).foo() cast inside the callback.

Methods

use()

ts
use(plugin, ...params): VizelMarkdownItInstance;

Defined in: packages/core/src/markdown/types.ts:15

Parameters

ParameterType
plugin(...args) => void
...paramsunknown[]

Returns

VizelMarkdownItInstance

Released under the MIT License.