<!doctype html>
< html class = "default no-js" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< title > MarkdownString | VS Code API< / title >
< meta name = "description" content = "Documentation for VS Code API" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< link rel = "stylesheet" href = "../assets/css/main.css" >
< script async src = "../assets/js/search.js" id = "search-script" > < / script >
< / head >
< body >
< header >
< div class = "tsd-page-toolbar" >
< div class = "container" >
< div class = "table-wrap" >
< div class = "table-cell" id = "tsd-search" data-index = "../assets/js/search.json" data-base = ".." >
< div class = "field" >
< label for = "tsd-search-field" class = "tsd-widget search no-caption" > Search< / label >
< input id = "tsd-search-field" type = "text" / >
< / div >
< ul class = "results" >
< li class = "state loading" > Preparing search index...< / li >
< li class = "state failure" > The search index is not available< / li >
< / ul >
< a href = "../index.html" class = "title" > VS Code API< / a >
< / div >
< div class = "table-cell" id = "tsd-widgets" >
< div id = "tsd-filter" >
< a href = "#" class = "tsd-widget options no-caption" data-toggle = "options" > Options< / a >
< div class = "tsd-filter-group" >
< div class = "tsd-select" id = "tsd-filter-visibility" >
< span class = "tsd-select-label" > All< / span >
< ul class = "tsd-select-list" >
< li data-value = "public" > Public< / li >
< li data-value = "protected" > Public/Protected< / li >
< li data-value = "private" class = "selected" > All< / li >
< / ul >
< / div >
< input type = "checkbox" id = "tsd-filter-inherited" checked / >
< label class = "tsd-widget" for = "tsd-filter-inherited" > Inherited< / label >
< input type = "checkbox" id = "tsd-filter-externals" checked / >
< label class = "tsd-widget" for = "tsd-filter-externals" > Externals< / label >
< / div >
< / div >
< a href = "#" class = "tsd-widget menu no-caption" data-toggle = "menu" > Menu< / a >
< / div >
< / div >
< / div >
< / div >
< div class = "tsd-page-title" >
< div class = "container" >
< ul class = "tsd-breadcrumb" >
< li >
< a href = "../modules.html" > VS Code API< / a >
< / li >
< li >
< a href = "MarkdownString.html" > MarkdownString< / a >
< / li >
< / ul >
< h1 > Class MarkdownString< / h1 >
< / div >
< / div >
< / header >
< div class = "container container-main" >
< div class = "row" >
< div class = "col-8 col-content" >
< section class = "tsd-panel tsd-comment" >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The MarkdownString represents human-readable text that supports formatting via the
markdown syntax. Standard markdown is supported, also tables, but no embedded html.< / p >
< / div >
< p > Rendering of < a href = "ThemeIcon.html" > theme icons< / a > via the < code > $(< name> )< / code > -syntax is supported
when the < a href = "MarkdownString.html#supportThemeIcons" > < code > supportThemeIcons< / code > < / a > is set to < code > true< / code > .< / p >
< / div >
< / section >
< section class = "tsd-panel tsd-hierarchy" >
< h3 > Hierarchy< / h3 >
< ul class = "tsd-hierarchy" >
< li >
< span class = "target" > MarkdownString< / span >
< / li >
< / ul >
< / section >
< section class = "tsd-panel-group tsd-index-group" >
< h2 > Index< / h2 >
< section class = "tsd-panel tsd-index-panel" >
< div class = "tsd-index-content" >
< section class = "tsd-index-section " >
< h3 > Constructors< / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-constructor tsd-parent-kind-class" > < a href = "MarkdownString.html#constructor" class = "tsd-kind-icon" > constructor< / a > < / li >
< / ul >
< / section >
< section class = "tsd-index-section " >
< h3 > Properties< / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "MarkdownString.html#value" class = "tsd-kind-icon" > value< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "MarkdownString.html#isTrusted" class = "tsd-kind-icon" > is< wbr > Trusted< / a > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "MarkdownString.html#supportThemeIcons" class = "tsd-kind-icon" > support< wbr > Theme< wbr > Icons< / a > < / li >
< / ul >
< / section >
< section class = "tsd-index-section " >
< h3 > Methods< / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "MarkdownString.html#appendText" class = "tsd-kind-icon" > append< wbr > Text< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "MarkdownString.html#appendMarkdown" class = "tsd-kind-icon" > append< wbr > Markdown< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "MarkdownString.html#appendCodeblock" class = "tsd-kind-icon" > append< wbr > Codeblock< / a > < / li >
< / ul >
< / section >
< / div >
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Constructors< / h2 >
< section class = "tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class" >
< a name = "constructor" class = "tsd-anchor" > < / a >
< h3 > constructor< / h3 >
< ul class = "tsd-signatures tsd-kind-constructor tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > new < wbr > Markdown< wbr > String< span class = "tsd-signature-symbol" > (< / span > value< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > , supportThemeIcons< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "MarkdownString.html" class = "tsd-signature-type" data-tsd-kind = "Class" > MarkdownString< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/f3e9d00/vscode.d.ts#L2597" > vscode.d.ts:2597< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Creates a new markdown string with the given value.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > value: < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Optional, initial value.< / p >
< / div >
< / div >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > supportThemeIcons: < span class = "tsd-signature-type" > boolean< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Optional, Specifies whether < a href = "ThemeIcon.html" > ThemeIcons< / a > are supported within the < a href = "MarkdownString.html" > < code > MarkdownString< / code > < / a > .< / p >
< / div >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "MarkdownString.html" class = "tsd-signature-type" data-tsd-kind = "Class" > MarkdownString< / a > < / h4 >
< / li >
< / ul >
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Properties< / h2 >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "value" class = "tsd-anchor" > < / a >
< h3 > value< / h3 >
< div class = "tsd-signature tsd-kind-icon" > value< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/f3e9d00/vscode.d.ts#L2578" > vscode.d.ts:2578< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The markdown string.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "isTrusted" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > is< wbr > Trusted< / h3 >
< div class = "tsd-signature tsd-kind-icon" > is< wbr > Trusted< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/f3e9d00/vscode.d.ts#L2584" > vscode.d.ts:2584< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Indicates that this markdown string is from a trusted source. Only < em > trusted< / em >
markdown supports links that execute commands, e.g. < code > [Run it](command:myCommandId)< / code > .< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class" >
< a name = "supportThemeIcons" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > support< wbr > Theme< wbr > Icons< / h3 >
< div class = "tsd-signature tsd-kind-icon" > support< wbr > Theme< wbr > Icons< span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > boolean< / span > < / div >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/f3e9d00/vscode.d.ts#L2589" > vscode.d.ts:2589< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Indicates that this markdown string can contain < a href = "ThemeIcon.html" > ThemeIcons< / a > , e.g. < code > $(zap)< / code > .< / p >
< / div >
< / div >
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Methods< / h2 >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
< a name = "appendText" class = "tsd-anchor" > < / a >
< h3 > append< wbr > Text< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > append< wbr > Text< span class = "tsd-signature-symbol" > (< / span > value< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "MarkdownString.html" class = "tsd-signature-type" data-tsd-kind = "Class" > MarkdownString< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/f3e9d00/vscode.d.ts#L2603" > vscode.d.ts:2603< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Appends and escapes the given string to this markdown string.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > value: < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > Plain text.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "MarkdownString.html" class = "tsd-signature-type" data-tsd-kind = "Class" > MarkdownString< / a > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
< a name = "appendMarkdown" class = "tsd-anchor" > < / a >
< h3 > append< wbr > Markdown< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > append< wbr > Markdown< span class = "tsd-signature-symbol" > (< / span > value< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "MarkdownString.html" class = "tsd-signature-type" data-tsd-kind = "Class" > MarkdownString< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/f3e9d00/vscode.d.ts#L2609" > vscode.d.ts:2609< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Appends the given string ' as is' to this markdown string. When < a href = "MarkdownString.html#supportThemeIcons" > < code > supportThemeIcons< / code > < / a > is < code > true< / code > , < a href = "ThemeIcon.html" > ThemeIcons< / a > in the < code > value< / code > will be iconified.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > value: < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > Markdown string.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "MarkdownString.html" class = "tsd-signature-type" data-tsd-kind = "Class" > MarkdownString< / a > < / h4 >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" >
< a name = "appendCodeblock" class = "tsd-anchor" > < / a >
< h3 > append< wbr > Codeblock< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" >
< li class = "tsd-signature tsd-kind-icon" > append< wbr > Codeblock< span class = "tsd-signature-symbol" > (< / span > value< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > , language< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "MarkdownString.html" class = "tsd-signature-type" data-tsd-kind = "Class" > MarkdownString< / a > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api/blob/f3e9d00/vscode.d.ts#L2616" > vscode.d.ts:2616< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Appends the given string as codeblock using the provided language.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > value: < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > A code snippet.< / p >
< / div >
< / li >
< li >
< h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > language: < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > An optional < a href = "../modules/languages.html#getLanguages" > language identifier< / a > .< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "MarkdownString.html" class = "tsd-signature-type" data-tsd-kind = "Class" > MarkdownString< / a > < / h4 >
< / li >
< / ul >
< / section >
< / section >
< / div >
< div class = "col-4 col-menu menu-sticky-wrap menu-highlight" >
< nav class = "tsd-navigation primary" >
< ul >
< li class = " " >
< a href = "../modules.html" > Exports< / a >
< / li >
< / ul >
< / nav >
< nav class = "tsd-navigation secondary menu-sticky" >
< ul class = "before-current" >
< / ul >
< ul class = "current" >
< li class = "current tsd-kind-class" >
< a href = "MarkdownString.html" class = "tsd-kind-icon" > Markdown< wbr > String< / a >
< ul >
< li class = " tsd-kind-constructor tsd-parent-kind-class" >
< a href = "MarkdownString.html#constructor" class = "tsd-kind-icon" > constructor< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "MarkdownString.html#value" class = "tsd-kind-icon" > value< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "MarkdownString.html#isTrusted" class = "tsd-kind-icon" > is< wbr > Trusted< / a >
< / li >
< li class = " tsd-kind-property tsd-parent-kind-class" >
< a href = "MarkdownString.html#supportThemeIcons" class = "tsd-kind-icon" > support< wbr > Theme< wbr > Icons< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-class" >
< a href = "MarkdownString.html#appendText" class = "tsd-kind-icon" > append< wbr > Text< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-class" >
< a href = "MarkdownString.html#appendMarkdown" class = "tsd-kind-icon" > append< wbr > Markdown< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-class" >
< a href = "MarkdownString.html#appendCodeblock" class = "tsd-kind-icon" > append< wbr > Codeblock< / a >
< / li >
< / ul >
< / li >
< / ul >
< ul class = "after-current" >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< footer class = "with-border-bottom" >
< div class = "container" >
< h2 > Legend< / h2 >
< div class = "tsd-legend-group" >
< ul class = "tsd-legend" >
< li class = "tsd-kind-constructor tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Constructor< / span > < / li >
< li class = "tsd-kind-property tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-inherited" > < span class = "tsd-kind-icon" > Inherited method< / span > < / li >
< / ul >
< ul class = "tsd-legend" >
< li class = "tsd-kind-property tsd-parent-kind-class tsd-is-static" > < span class = "tsd-kind-icon" > Static property< / span > < / li >
< li class = "tsd-kind-method tsd-parent-kind-class tsd-is-static" > < span class = "tsd-kind-icon" > Static method< / span > < / li >
< / ul >
< / div >
< / div >
< / footer >
< div class = "container tsd-generator" >
< p > Generated using < a href = "https://typedoc.org/" target = "_blank" > TypeDoc< / a > < / p >
< / div >
< div class = "overlay" > < / div >
< script src = "../assets/js/main.js" > < / script >
< / body >
< / html >
