Supported Markdown Syntax in Blazor Markdown Editor Component

18 Mar 20256 minutes to read

The Syncfusion Blazor Markdown editor supports various Markdown syntax commands for text formatting, lists, links, tables, and more. This guide provides an overview of all supported commands along with their syntax and usage.

Markdown Syntax Guide for Blazor Markdown Editor

The following table lists the Markdown commands supported by the Syncfusion Blazor Markdown Editor:

Commands Syntax Description
Bold Sample content for **bold text**. For bold, add ** or __ to front and back of the text. For order list, precede each line with a number.
Italic Sample content for *Italic text*. For Italic, add * or _ to front and back of the text.
Bold and Italics Sample content for ***bold and Italic text***. For bold and Italics, add *** to the front and back of the text.
Heading 1 # Heading 1 content For heading 1, add # to start of the line.
Heading 2 ## Heading 2 content For heading 2, add ## to start of the line.
Heading 3 ### Heading 3 content For heading 3, add ### to start of the line.
Heading 4 #### Heading 4 content For heading 4, add #### to start of the line.
Heading 5 ##### Heading 5 content For heading 5, add ##### to start of the line.
Heading 6 ###### Heading 6 content For heading 6, add ###### to start of the line.
Line Break First line <br>Second line For line break, press enter two times (or) add <br> in between the first and the second line.
Blockquotes > Blockquotes text For blockquotes, add > to start of the line.
Strike Through Sample content for ~~strike through text~~. For strike through, add ~~ to front and back of the text.
Code (Single line) `Single line code` For single line code, add ` to front and back of the text.
Code block (Multi Line) ```
Multi line code text
Multi line code text
```		 For multiple line code, add ``` in the new line before and after the content.
Subscript <sub>Subscript text</sub> For subscript, add <sub> to the front and </sub> to the back of the text.
Superscript <sup>Superscript text</sup> For superscript, add <sup> to the front and </sup> to the back of the text.
Ordered List 1. First
1. Second		 For ordered list, preceding one or more lines of text with 1.
Unordered List * First
* second		 For unordered list, preceding one or more lines of text with *.
Links Link text without title text
[ Link text ](URL)
Link text with title text
[ Link text ](URL , “title text”) 		Create an inline link by wrapping link text in brackets [ ], and then wrapping the URL as first parameter and title as second parameter in the parentheses ().
Note: The title text is optional, if needed it can be given manually.
Table | Heading 1 | Heading 2 |
|---------|---------|
| Col A1 | Col A2 |
| Col B1 | Col B2 | 		Create a table using the pipes and underscores as given in the syntax to create 2 x 2 table.
Horizontal Line *** (three asterisk in new line)
(or)
___ (three underscores in new line)		 For horizontal line, add *** or ___ to the start of the new line.
Image ![alt text](URL path) Create an image by wrapping the image source in parentheses ().
Image with alternate text ![ alternate text ](URL path) Create an image with alternate text by wrapping an alternative text in brackets [ ], and then link of the image source in parentheses ().
Note: When inserting the image using toolbar, the alternate text cannot be provided that needs to be given manually.
Escape tick marks supported Sample text content with **bold and **not bold** text can be in the same line.** In the syntax, the whole content is made as bold where the content not bold can be made as normal text by adding the bold syntax to the start and end of the respective text. Likewise you can do the same for various inline commands.
Escape Character \(any syntax) Escape any markdown syntax by prefix \ to the syntax.
Example:
\**Bold text**
HTML Entities Copyright: © - &copy;
Trade mark: ™ - &trade;
Registered: ® - <sup style="font-size:70%">&reg;</sup>
Ampersand: & - &amp;
Less than: < - &lt;
Greater than: > - &gt; 		For HTML entities, add & and ; to the front and back of the respective entities.

NOTE

The above listed commands alone are supported in Syncfusion® markdown editor. For other unsupported commands, you can achieve using the HTML tags in markdown editor. The foot notes, definitions, math, and check list markdown syntax are also not supported.