MarkdownString$Typings extension
Properties
- baseUri ↔ Uri
-
Available on MarkdownString, provided by the MarkdownString$Typings extension
Uri that relative paths are resolved relative to.getter/setter pair - isTrusted ↔ Object
-
Available on MarkdownString, provided by the MarkdownString$Typings extension
Indicates that this markdown string is from a trusted source. Only trusted markdown supports links that execute commands, e.g.[Run it](command:myCommandId)
.getter/setter pair - supportHtml ↔ bool
-
Available on MarkdownString, provided by the MarkdownString$Typings extension
Indicates that this markdown string can contain raw html tags. Defaults tofalse
.getter/setter pair - supportThemeIcons ↔ bool
-
Available on MarkdownString, provided by the MarkdownString$Typings extension
Indicates that this markdown string can contain {@link ThemeIcon ThemeIcons}, e.g.$(zap)
.getter/setter pair - value ↔ String
-
Available on MarkdownString, provided by the MarkdownString$Typings extension
The markdown string.getter/setter pair
Methods
-
appendCodeblock(
String value, [String? language]) → MarkdownString -
Available on MarkdownString, provided by the MarkdownString$Typings extension
Appends the given string as codeblock using the provided language. @param value A code snippet. @param language An optional {@link languages.getLanguages language identifier}. -
appendMarkdown(
String value) → MarkdownString -
Available on MarkdownString, provided by the MarkdownString$Typings extension
Appends the given string 'as is' to this markdown string. When {@linkcode MarkdownString.supportThemeIcons supportThemeIcons} istrue
, {@link ThemeIcon ThemeIcons} in thevalue
will be iconified. @param value Markdown string. -
appendText(
String value) → MarkdownString -
Available on MarkdownString, provided by the MarkdownString$Typings extension
Appends and escapes the given string to this markdown string. @param value Plain text.