Interface MarkdownExtensionSpec

Extension contract for markdown parsing/serialization.

interface MarkdownExtensionSpec {
    isIndenting?: boolean;
    nodeName?: string;
    parseMarkdown?: (
        token: MarkdownToken,
        helpers: MarkdownParseHelpers,
    ) => MarkdownParseResult;
    renderMarkdown?: (
        node: any,
        helpers: MarkdownRendererHelpers,
        ctx: RenderContext,
    ) => string;
    tokenizer?: MarkdownTokenizer;
    tokenName?: string;
}

Index

Properties

isIndenting? nodeName? parseMarkdown? renderMarkdown? tokenizer? tokenName?

Properties

`Optional`isIndenting

isIndenting?: boolean

`Optional`nodeName

nodeName?: string

Node/mark name used for rendering (typically the extension name)

`Optional`parseMarkdown

parseMarkdown?: (
token: MarkdownToken,
helpers: MarkdownParseHelpers,
) => MarkdownParseResult

`Optional`renderMarkdown

renderMarkdown?: (
    node: any,
    helpers: MarkdownRendererHelpers,
    ctx: RenderContext,
) => string

`Optional`tokenizer

tokenizer?: MarkdownTokenizer

Custom tokenizer for marked.js to handle non-standard markdown syntax

`Optional`tokenName

tokenName?: string

Token name used for parsing (e.g., 'codespan', 'code', 'strong')