Skip to main content

MarkdownParseHelpers

@blockslides/core

@blockslides/core / MarkdownParseHelpers

Type Alias: MarkdownParseHelpers

MarkdownParseHelpers = object

Defined in: blockslides/packages/core/src/types.ts:858

Helpers specifically for parsing markdown tokens into blockslides JSON. These are provided to extension parse handlers.

Properties​

parseInline()​

parseInline: (tokens) => JSONContent[]

Defined in: blockslides/packages/core/src/types.ts:860

Parse an array of inline tokens into text nodes with marks

Parameters​

tokens​

MarkdownToken[]

Returns​

JSONContent[]

parseChildren()​

parseChildren: (tokens) => JSONContent[]

Defined in: blockslides/packages/core/src/types.ts:862

Parse an array of block-level tokens

Parameters​

tokens​

MarkdownToken[]

Returns​

JSONContent[]

createTextNode()​

createTextNode: (text, marks?) => JSONContent

Defined in: blockslides/packages/core/src/types.ts:864

Create a text node with optional marks

Parameters​

text​

string

marks?​

object[]

Returns​

JSONContent

createNode()​

createNode: (type, attrs?, content?) => JSONContent

Defined in: blockslides/packages/core/src/types.ts:869

Create any node type with attributes and content

Parameters​

type​

string

attrs?​

any

content?​

JSONContent[]

Returns​

JSONContent

applyMark()​

applyMark: (markType, content, attrs?) => object

Defined in: blockslides/packages/core/src/types.ts:875

Apply a mark to content (used for inline marks like bold, italic)

Parameters​

markType​

string

content​

JSONContent[]

attrs?​

any

Returns​

object

mark​

mark: string

content​

content: JSONContent[]

attrs?​

optional attrs: any