Interface MarkdownNodeParameters

Source
interface MarkdownNodeParameters {
    destinationKey?: string;
    html?: string;
    markdown?: string;
    mode?: "markdownToHtml" | "htmlToMarkdown";
    options?:
        | {
            blockElements?: string;
            bulletMarker?: string;
            codeBlockStyle?: "fence"
            | "indented";
            codeFence?: string;
            emDelimiter?: string;
            globalEscape?: {
                value: { pattern?: string; replacement?: string };
            };
            ignore?: string;
            keepDataImages?: boolean;
            lineStartEscape?: {
                value: { pattern?: string; replacement?: string };
            };
            maxConsecutiveNewlines?: number;
            strongDelimiter?: string;
            textReplace?: {
                values: {
                    pattern?: string;
                    replacement?: string;
                }[];
            };
            useLinkReferenceDefinitions?: boolean;
        }
        | {
            backslashEscapesHTMLTags?: boolean;
            completeHTMLDocument?: boolean;
            customizedHeaderId?: boolean;
            disableForced4SpacesIndentedSublists?: boolean;
            emoji?: boolean;
            encodeEmails?: boolean;
            excludeTrailingPunctuationFromURLs?: boolean;
            ghCodeBlocks?: boolean;
            ghCompatibleHeaderId?: boolean;
            ghMentions?: boolean;
            ghMentionsLink?: string;
            headerLevelStart?: number;
            literalMidWordAsterisks?: boolean;
            literalMidWordUnderscores?: boolean;
            noHeaderId?: boolean;
            openLinksInNewWindow?: boolean;
            parseImgDimensions?: boolean;
            prefixHeaderId?: string;
            rawHeaderId?: boolean;
            rawPrefixHeaderId?: boolean;
            requireSpaceBeforeHeadingText?: boolean;
            simpleLineBreaks?: boolean;
            simplifiedAutoLink?: boolean;
            smartIndentationFix?: boolean;
            splitAdjacentBlockquotes?: boolean;
            strikethrough?: boolean;
            tables?: boolean;
            tablesHeaderId?: boolean;
            tasklists?: boolean;
        };
}

Properties§

Source§

readonly destinationKey?: string

The field to put the output in. Specify nested fields using dots, e.g."level1.level2.newKey". Default: "data"

Source§

readonly html?: string

The HTML to be converted to markdown

Source§

readonly markdown?: string

The Markdown to be converted to html

Source§

readonly mode?: "markdownToHtml" | "htmlToMarkdown"

Default: "htmlToMarkdown"

Source§

readonly options?:
    | {
        blockElements?: string;
        bulletMarker?: string;
        codeBlockStyle?: "fence"
        | "indented";
        codeFence?: string;
        emDelimiter?: string;
        globalEscape?: {
            value: { pattern?: string; replacement?: string };
        };
        ignore?: string;
        keepDataImages?: boolean;
        lineStartEscape?: {
            value: { pattern?: string; replacement?: string };
        };
        maxConsecutiveNewlines?: number;
        strongDelimiter?: string;
        textReplace?: {
            values: { pattern?: string; replacement?: string }[];
        };
        useLinkReferenceDefinitions?: boolean;
    }
    | {
        backslashEscapesHTMLTags?: boolean;
        completeHTMLDocument?: boolean;
        customizedHeaderId?: boolean;
        disableForced4SpacesIndentedSublists?: boolean;
        emoji?: boolean;
        encodeEmails?: boolean;
        excludeTrailingPunctuationFromURLs?: boolean;
        ghCodeBlocks?: boolean;
        ghCompatibleHeaderId?: boolean;
        ghMentions?: boolean;
        ghMentionsLink?: string;
        headerLevelStart?: number;
        literalMidWordAsterisks?: boolean;
        literalMidWordUnderscores?: boolean;
        noHeaderId?: boolean;
        openLinksInNewWindow?: boolean;
        parseImgDimensions?: boolean;
        prefixHeaderId?: string;
        rawHeaderId?: boolean;
        rawPrefixHeaderId?: boolean;
        requireSpaceBeforeHeadingText?: boolean;
        simpleLineBreaks?: boolean;
        simplifiedAutoLink?: boolean;
        smartIndentationFix?: boolean;
        splitAdjacentBlockquotes?: boolean;
        strikethrough?: boolean;
        tables?: boolean;
        tablesHeaderId?: boolean;
        tasklists?: boolean;
    }

Default: {}