Class Markdown
Inheritance
Namespace: AeLa.EasyFeedback.Utility
Assembly: cs.temp.dll.dll
Syntax
public static class Markdown
Fields
HR
Creates a horizontal rule or line
Declaration
public const string HR = "---"
Field Value
| Type | Description |
|---|---|
| string |
LINE_BREAK
Creates a new paragraph
Declaration
public const string LINE_BREAK = "\n\n"
Field Value
| Type | Description |
|---|---|
| string |
Methods
Blockquote(string)
Creates a block of quoted text
Declaration
public static string Blockquote(string text)
Parameters
| Type | Name | Description |
|---|---|---|
| string | text | The text |
Returns
| Type | Description |
|---|---|
| string |
Code(string)
Creates an inline span of preformatted text
Declaration
public static string Code(string text)
Parameters
| Type | Name | Description |
|---|---|---|
| string | text | The text |
Returns
| Type | Description |
|---|---|
| string |
CodeBlock(string, string)
Creates a block of preformatted text
Declaration
public static string CodeBlock(string text, string language = "")
Parameters
| Type | Name | Description |
|---|---|---|
| string | text | The text |
| string | language | The language for syntax highlighting (where supported) |
Returns
| Type | Description |
|---|---|
| string |
Em(string)
Formats the text with emphasis/italics
Declaration
public static string Em(string text)
Parameters
| Type | Name | Description |
|---|---|---|
| string | text | The text to be emphasized |
Returns
| Type | Description |
|---|---|
| string |
H1(string)
Creates a first-level header from the specified text
Declaration
public static string H1(string text)
Parameters
| Type | Name | Description |
|---|---|---|
| string | text | The header text |
Returns
| Type | Description |
|---|---|
| string |
H2(string)
Creates a second-level header from the specified text
Declaration
public static string H2(string text)
Parameters
| Type | Name | Description |
|---|---|---|
| string | text | The header text |
Returns
| Type | Description |
|---|---|
| string |
H3(string)
Creates a third-level header from the specified text
Declaration
public static string H3(string text)
Parameters
| Type | Name | Description |
|---|---|---|
| string | text | The header text |
Returns
| Type | Description |
|---|---|
| string |
H4(string)
Creates a fourth-level header from the specified text
Declaration
public static string H4(string text)
Parameters
| Type | Name | Description |
|---|---|---|
| string | text | The header text |
Returns
| Type | Description |
|---|---|
| string |
H5(string)
Creates a fifth-level header from the specified text
Declaration
public static string H5(string text)
Parameters
| Type | Name | Description |
|---|---|---|
| string | text | The header text |
Returns
| Type | Description |
|---|---|
| string |
H6(string)
Creates a sixth-level header from the specified text
Declaration
public static string H6(string text)
Parameters
| Type | Name | Description |
|---|---|---|
| string | text | The header text |
Returns
| Type | Description |
|---|---|
| string |
Header(string, HeaderLevel)
Creates a header from the specified text, with the specified level
Declaration
public static string Header(string text, Markdown.HeaderLevel level = HeaderLevel.H1)
Parameters
| Type | Name | Description |
|---|---|---|
| string | text | The header text |
| Markdown.HeaderLevel | level | The header level |
Returns
| Type | Description |
|---|---|
| string |
Hyperlink(string, string)
Creates an inline link
Declaration
public static string Hyperlink(string text, string url)
Parameters
| Type | Name | Description |
|---|---|---|
| string | text | The link text |
| string | url | The link url |
Returns
| Type | Description |
|---|---|
| string |
Image(string, string)
Creates an inline image
Declaration
public static string Image(string url, string alt = "")
Parameters
| Type | Name | Description |
|---|---|---|
| string | url | The url of the image |
| string | alt | The alt-text for the image |
Returns
| Type | Description |
|---|---|
| string |
OrderedList(string[])
Creates an ordered (numbered) list from an array of items
Declaration
public static string OrderedList(string[] items)
Parameters
| Type | Name | Description |
|---|---|---|
| string[] | items | The items of the list |
Returns
| Type | Description |
|---|---|
| string |
Strike(string)
Strikes through the text
Declaration
public static string Strike(string text)
Parameters
| Type | Name | Description |
|---|---|---|
| string | text | The text |
Returns
| Type | Description |
|---|---|
| string |
Strong(string)
Emboldens the text
Declaration
public static string Strong(string text)
Parameters
| Type | Name | Description |
|---|---|---|
| string | text | The text to be emboldened |
Returns
| Type | Description |
|---|---|
| string |
UnorderedList(string[])
Creates an unordered (bulleted) list from an array of items
Declaration
public static string UnorderedList(string[] items)
Parameters
| Type | Name | Description |
|---|---|---|
| string[] | items | The items of the list |
Returns
| Type | Description |
|---|---|
| string |