dots.vscode.markdown-string
Human-readable text that supports formatting via the markdown syntax.
Rendering of {@link ThemeIcon 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.
Human-readable text that supports formatting via the [markdown syntax](https://commonmark.org).
Rendering of {@link ThemeIcon 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`.append-codeblockcljs
(append-codeblock markdown-string value)(append-codeblock markdown-string value language)Appends the given string as codeblock using the provided language.
Parameters:
value:string- A code snippet.language:string | undefined- An optional {@link languages.getLanguages language identifier}.
Returns: MarkdownString
Appends the given string as codeblock using the provided language.
**Parameters:**
- `value`: `string` - A code snippet.
- `language`: `string | undefined` - An optional {@link languages.getLanguages language identifier}.
**Returns:** `MarkdownString`append-markdowncljs
(append-markdown markdown-string value)Appends the given string 'as is' to this markdown string. When {@linkcode MarkdownString.supportThemeIcons supportThemeIcons} is true, {@link ThemeIcon ThemeIcons} in the value will be iconified.
Parameters:
value:string- Markdown string.
Returns: MarkdownString
Appends the given string 'as is' to this markdown string. When {@linkcode MarkdownString.supportThemeIcons supportThemeIcons} is `true`, {@link ThemeIcon ThemeIcons} in the `value` will be iconified.
**Parameters:**
- `value`: `string` - Markdown string.
**Returns:** `MarkdownString`append-textcljs
(append-text markdown-string value)Appends and escapes the given string to this markdown string.
Parameters:
value:string- Plain text.
Returns: MarkdownString
Appends and escapes the given string to this markdown string. **Parameters:** - `value`: `string` - Plain text. **Returns:** `MarkdownString`
base-uricljs
(base-uri markdown-string)Uri that relative paths are resolved relative to.
If the baseUri ends with /, it is considered a directory and relative paths in the markdown are resolved relative to that directory:
const md = new vscode.MarkdownString(`[link](./file.js)`);
md.baseUri = vscode.Uri.file('/path/to/dir/');
// Here 'link' in the rendered markdown resolves to '/path/to/dir/file.js'
If the baseUri is a file, relative paths in the markdown are resolved relative to the parent dir of that file:
const md = new vscode.MarkdownString(`[link](./file.js)`);
md.baseUri = vscode.Uri.file('/path/to/otherFile.js');
// Here 'link' in the rendered markdown resolves to '/path/to/file.js'
Returns: Uri | undefined
Uri that relative paths are resolved relative to.
If the `baseUri` ends with `/`, it is considered a directory and relative paths in the markdown are resolved relative to that directory:
```ts
const md = new vscode.MarkdownString(`[link](./file.js)`);
md.baseUri = vscode.Uri.file('/path/to/dir/');
// Here 'link' in the rendered markdown resolves to '/path/to/dir/file.js'
```
If the `baseUri` is a file, relative paths in the markdown are resolved relative to the parent dir of that file:
```ts
const md = new vscode.MarkdownString(`[link](./file.js)`);
md.baseUri = vscode.Uri.file('/path/to/otherFile.js');
// Here 'link' in the rendered markdown resolves to '/path/to/file.js'
```
**Returns:** `Uri | undefined`set-base-uri!cljs
(set-base-uri! markdown-string value)Uri that relative paths are resolved relative to.
If the baseUri ends with /, it is considered a directory and relative paths in the markdown are resolved relative to that directory:
const md = new vscode.MarkdownString(`[link](./file.js)`);
md.baseUri = vscode.Uri.file('/path/to/dir/');
// Here 'link' in the rendered markdown resolves to '/path/to/dir/file.js'
If the baseUri is a file, relative paths in the markdown are resolved relative to the parent dir of that file:
const md = new vscode.MarkdownString(`[link](./file.js)`);
md.baseUri = vscode.Uri.file('/path/to/otherFile.js');
// Here 'link' in the rendered markdown resolves to '/path/to/file.js'
Uri that relative paths are resolved relative to.
If the `baseUri` ends with `/`, it is considered a directory and relative paths in the markdown are resolved relative to that directory:
```ts
const md = new vscode.MarkdownString(`[link](./file.js)`);
md.baseUri = vscode.Uri.file('/path/to/dir/');
// Here 'link' in the rendered markdown resolves to '/path/to/dir/file.js'
```
If the `baseUri` is a file, relative paths in the markdown are resolved relative to the parent dir of that file:
```ts
const md = new vscode.MarkdownString(`[link](./file.js)`);
md.baseUri = vscode.Uri.file('/path/to/otherFile.js');
// Here 'link' in the rendered markdown resolves to '/path/to/file.js'
```set-is-trusted!cljs
(set-is-trusted! markdown-string value)Indicates that this markdown string is from a trusted source. Only trusted
markdown supports links that execute commands, e.g. [Run it](command:myCommandId).
Defaults to false (commands are disabled).
Indicates that this markdown string is from a trusted source. Only *trusted* markdown supports links that execute commands, e.g. `[Run it](command:myCommandId)`. Defaults to `false` (commands are disabled).
set-support-html!cljs
(set-support-html! markdown-string value)Indicates that this markdown string can contain raw html tags. Defaults to false.
When supportHtml is false, the markdown renderer will strip out any raw html tags
that appear in the markdown text. This means you can only use markdown syntax for rendering.
When supportHtml is true, the markdown render will also allow a safe subset of html tags
and attributes to be rendered. See https://github.com/microsoft/vscode/blob/6d2920473c6f13759c978dd89104c4270a83422d/src/vs/base/browser/markdownRenderer.ts#L296
for a list of all supported tags and attributes.
Indicates that this markdown string can contain raw html tags. Defaults to `false`. When `supportHtml` is false, the markdown renderer will strip out any raw html tags that appear in the markdown text. This means you can only use markdown syntax for rendering. When `supportHtml` is true, the markdown render will also allow a safe subset of html tags and attributes to be rendered. See https://github.com/microsoft/vscode/blob/6d2920473c6f13759c978dd89104c4270a83422d/src/vs/base/browser/markdownRenderer.ts#L296 for a list of all supported tags and attributes.
set-support-theme-icons!cljs
(set-support-theme-icons! markdown-string value)Indicates that this markdown string can contain {@link ThemeIcon ThemeIcons}, e.g. $(zap).
Indicates that this markdown string can contain {@link ThemeIcon ThemeIcons}, e.g. `$(zap)`.
set-value!cljs
(set-value! markdown-string value)The markdown string.
The markdown string.
support-html?cljs
(support-html? markdown-string)Indicates that this markdown string can contain raw html tags. Defaults to false.
When supportHtml is false, the markdown renderer will strip out any raw html tags
that appear in the markdown text. This means you can only use markdown syntax for rendering.
When supportHtml is true, the markdown render will also allow a safe subset of html tags
and attributes to be rendered. See https://github.com/microsoft/vscode/blob/6d2920473c6f13759c978dd89104c4270a83422d/src/vs/base/browser/markdownRenderer.ts#L296
for a list of all supported tags and attributes.
Returns: boolean | undefined
Indicates that this markdown string can contain raw html tags. Defaults to `false`. When `supportHtml` is false, the markdown renderer will strip out any raw html tags that appear in the markdown text. This means you can only use markdown syntax for rendering. When `supportHtml` is true, the markdown render will also allow a safe subset of html tags and attributes to be rendered. See https://github.com/microsoft/vscode/blob/6d2920473c6f13759c978dd89104c4270a83422d/src/vs/base/browser/markdownRenderer.ts#L296 for a list of all supported tags and attributes. **Returns:** `boolean | undefined`
support-theme-icons?cljs
(support-theme-icons? markdown-string)Indicates that this markdown string can contain {@link ThemeIcon ThemeIcons}, e.g. $(zap).
Returns: boolean | undefined
Indicates that this markdown string can contain {@link ThemeIcon ThemeIcons}, e.g. `$(zap)`.
**Returns:** `boolean | undefined`trusted?cljs
(trusted? markdown-string)Indicates that this markdown string is from a trusted source. Only trusted
markdown supports links that execute commands, e.g. [Run it](command:myCommandId).
Defaults to false (commands are disabled).
Returns: boolean | { readonly enabledCommands: readonly string[]; } | undefined
Indicates that this markdown string is from a trusted source. Only *trusted*
markdown supports links that execute commands, e.g. `[Run it](command:myCommandId)`.
Defaults to `false` (commands are disabled).
**Returns:** `boolean | { readonly enabledCommands: readonly string[]; } | undefined`valuecljs
(value markdown-string)The markdown string.
Returns: string
The markdown string. **Returns:** `string`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close