Options
All
  • Public
  • Public/Protected
  • All
Menu

The MarkdownString represents human-readable text that supports formatting via the markdown syntax. Standard markdown is supported, also tables, but no embedded html.

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

层级

  • MarkdownString

索引

Constructors(1)

Properties(3)

Methods(3)

Constructors(1)

constructor

  • new MarkdownString(value?: string, supportThemeIcons?: boolean): MarkdownString
  • Creates a new markdown string with the given value.

    Parameters

    • Optional value: string

      Optional, initial value.

    • Optional supportThemeIcons: boolean

      Optional, Specifies whether ThemeIcons are supported within the MarkdownString.

    Returns MarkdownString

Properties(3)

value

value: string

The markdown string.

Optional isTrusted

isTrusted: boolean

Indicates that this markdown string is from a trusted source. Only trusted markdown supports links that execute commands, e.g. [Run it](command:myCommandId).

Optional supportThemeIcons

supportThemeIcons: boolean

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

Methods(3)

appendText

  • Appends and escapes the given string to this markdown string.

    Parameters

    • value: string

      Plain text.

    Returns MarkdownString

appendMarkdown

appendCodeblock

友链:VS Code 中文文档 | VS Code 官网文档 | VS Code 扩展市场

Generated by TypeDoc. Maintained by 洛竹