Skip to content

mattermosthelpers MarkdownHelpers

BigMakCode edited this page Aug 5, 2024 · 1 revision

MarkdownHelpers Internal class

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph Mattermost.Helpers
  Mattermost.Helpers.MarkdownHelpers[[MarkdownHelpers]]
  end
Loading

Members

Methods

Internal Static methods

Returns Name
string Bold(string text)
string BoldItalic(string text)
string ChannelMention(string channelName)
string CodeBlock(string text, CodeLanguage language)
string Escape(string text)
string Header(string text, int level)
string Image(string altText, string url)
string InlineCode(string text)
string Italic(string text)
string Link(string text, string url)
string Mention(string username)
string OrderedList(string``[] items)
string Quote(string text)
string StrikeThrough(string text)
string TaskList(...)
string UnorderedList(...)

Details

Constructors

MarkdownHelpers

public MarkdownHelpers()

Methods

Bold

internal static string Bold(string text)
Arguments
Type Name Description
string text

Italic

internal static string Italic(string text)
Arguments
Type Name Description
string text

BoldItalic

internal static string BoldItalic(string text)
Arguments
Type Name Description
string text

StrikeThrough

internal static string StrikeThrough(string text)
Arguments
Type Name Description
string text

InlineCode

internal static string InlineCode(string text)
Arguments
Type Name Description
string text

CodeBlock

internal static string CodeBlock(string text, CodeLanguage language)
Arguments
Type Name Description
string text
CodeLanguage language

Quote

internal static string Quote(string text)
Arguments
Type Name Description
string text

Link

internal static string Link(string text, string url)
Arguments
Type Name Description
string text
string url

Image

internal static string Image(string altText, string url)
Arguments
Type Name Description
string altText
string url

Mention

internal static string Mention(string username)
Arguments
Type Name Description
string username

ChannelMention

internal static string ChannelMention(string channelName)
Arguments
Type Name Description
string channelName

Header

internal static string Header(string text, int level)
Arguments
Type Name Description
string text
int level

OrderedList

internal static string OrderedList(string[] items)
Arguments
Type Name Description
string``[] items

UnorderedList [1/2]

internal static string UnorderedList(string[] items)
Arguments
Type Name Description
string``[] items

UnorderedList [2/2]

internal static string UnorderedList((string Item1, int Item2)[] values)
Arguments
Type Name Description
(string Item1, int Item2)[] values

TaskList [1/2]

internal static string TaskList(string[] items)
Arguments
Type Name Description
string``[] items

TaskList [2/2]

internal static string TaskList((string Item1, bool Item2)[] items)
Arguments
Type Name Description
(string Item1, bool Item2)[] items

Escape

internal static string Escape(string text)
Arguments
Type Name Description
string text

Generated with ModularDoc

Clone this wiki locally