Skip to main content

markdownifyToString

Parses a markdown string to a plain text string.

Signature

markdownifyToString(
markdown: string,
context?: Context,
placeholder?: string,
lineBreaks?: boolean,
features?: MarkdownFeatures
): string

Parameters

NameTypeOptionalDescription
markdownstringNoSpecifies the markdown text to parse.
contextContextYesOptional context for the parser. This context is used when referencing variables.
placeholderstringYesSpecifies a string for empty variables (defaults to ___).
lineBreaksstringYesSpecifies if line breaks are supported (defaults to false).
featuresMarkdownFeaturesYesSpecifies the features to parse (defaults to None).

Return value

Returns a plain text string where all markdown is removed/parsed.