Search results

Markdown

In RichTextEditor, click the toolbar buttons to format the words and the changes are visible immediately.

Markdown is not like that. When you format the word in Markdown format, you need to add Markdown syntax to the word to indicate which words and phrases should look different from each other. RichTextEditor supports markdown editing when the EditorMode set as Markdown and using both keyboard interaction and toolbar action, you can apply the formatting to text.

Supported Commands

The Blazor Markdown editor supports the following commands to format the markdown content:

Commands Syntax Description
Bold Sample content for **bold text**. For bold, add ** or __ to front and back of the text.
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 asterix in new line)
(or)
___ (three underscores in new line)
For horizontal line, add *** or ___ to the start of the new line.
Image ![](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: ® - &reg;
Ampersand: & - &amp;
Less than: < - &lt;
Greater than: > - &gt;
For HTML entities, add & and ; to the front and back of the respective entities.

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.

Table

RichTextEditor allows you to insert Markdown table in edit panel with 2 X 2 rows and columns along with the heading. To use table tool, add the CreateTable item in toolbar items.

Insert table

To insert the table in RichTextEditor, click the Table toolbar option to insert the table into RichTextEditor content and this is the default way in all the devices. Refer to the following sample and code snippets to add the table in Markdown editor.

@using Syncfusion.EJ2.Blazor
@using Syncfusion.EJ2.Blazor.RichTextEditor

<EjsRichTextEditor EditorMode="EditorMode.Markdown" Height="340px" Placeholder="Type Something">
    <RichTextEditorToolbarSettings Items="@Tools"></RichTextEditorToolbarSettings>
    In RichTextEditor , you click the toolbar buttons to format the words and the changes are visible immediately.
    Markdown is not like that. When you format the word in Markdown format, you need to add Markdown syntax to the word to indicate which words
    and phrases should look different from each other.
    RichTextEditor supports markdown editing when the editorMode set as **markdown** and using both *keyboard interaction* and *toolbar action*,
    you can apply the formatting to text.
    We can add our own custom formation syntax for the Markdown formation, [sample link](https://ej2.syncfusion.com/home/).
    The third-party library <b>Marked</b> is used in this sample to convert markdown into HTML content.

    Markdown Table Format
    |Heading 1|Heading 2|
    |---------|---------|
    |Col A1|Col A2|
    |Col B1|Col B2|
</EjsRichTextEditor>


@code {
    public object[] Tools = new object[]{
        "CreateTable"
    };
}

The output will be as follows.

Table

Changing table constants

The Markdown table constants can be changed for the table heading and the column names.

See Also