MarkdownString

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

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

Rendering of embedded html is supported when {@linkcode supportHtml} is set to true.

Online Documentation

Constructors

MarkdownString

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

Creates a new markdown string with the given value.

Properties

baseUri

var baseUri: Uri?

Uri that relative paths are resolved relative to.

supportHtml

var supportHtml: Boolean?

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

supportThemeIcons

var supportThemeIcons: Boolean?

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

value

var value: String

The markdown string.

Functions

appendCodeblock

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

Appends the given string as codeblock using the provided language.

appendMarkdown

fun appendMarkdown(value: String): MarkdownString

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

appendText

fun appendText(value: String): MarkdownString

Appends and escapes the given string to this markdown string.