Skip to content

Vizel API / core/src / VizelMarkdownOptions

Interface: VizelMarkdownOptions

Defined in: packages/core/src/extensions/markdown.ts:42

Configuration options for the Vizel Markdown extension.

Properties

breaks?

ts
optional breaks?: boolean;

Defined in: packages/core/src/extensions/markdown.ts:57

Convert single newlines to <br> tags.

Default

ts
false

flavor?

ts
optional flavor?: VizelMarkdownFlavor;

Defined in: packages/core/src/extensions/markdown.ts:64

Flavor plugin that contributes markdown-it parser plugins and per-node / per-mark serializer overrides. The runtime callers inject the editor's flavor here; consumers do not normally pass this option directly.


gfm?

ts
optional gfm?: boolean;

Defined in: packages/core/src/extensions/markdown.ts:52

Enable GitHub Flavored Markdown features (links autolinked).

Default

ts
true

indentation?

ts
optional indentation?: VizelMarkdownIndentation;

Defined in: packages/core/src/extensions/markdown.ts:47

Configure indentation for markdown output.

Default

ts
{ style: 'space', size: 2 }

Released under the MIT License.