MarkdownString

Human-readable text that supports formatting via the markdown syntax.

Rendering of theme icons via the $(<name>)-syntax is supported when the supportThemeIcons is set to true.

Rendering of embedded html is supported when supportHtml is set to true.

Constructors

constructor(value: String = definedExternally, supportThemeIcons: Boolean = definedExternally)

Creates a new markdown string with the given value.

Uri that relative paths are resolved relative to.

Indicates that this markdown string can contain raw html tags. Defaults to false.

Indicates that this markdown string can contain ThemeIcons, e.g. $(zap).

The markdown string.

fun appendCodeblock(value: String, language: String = definedExternally): MarkdownString

Appends the given string as codeblock using the provided language.

Appends the given string 'as is' to this markdown string. When supportThemeIcons is true, ThemeIcons in the value will be iconified.

Appends and escapes the given string to this markdown string.