Class Markdown
Namespace: AeLa.EasyFeedback.Utility
Assembly: cs.temp.dll.dll
Syntax
public static class MarkdownFields
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, Markdown.HeaderLevel)
Creates a header from the specified text, with the specified level
Declaration
public static string Header(string text, Markdown.HeaderLevel level = Markdown.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 |