Skip to content

Commit 51fe057

Browse files
authored
Merge pull request #6815 from syncfusion-content/983303-markdown-d
983303: Updated markdown-editor documentation
2 parents 58f32b1 + 23260cb commit 51fe057

File tree

10 files changed

+74
-54
lines changed

10 files changed

+74
-54
lines changed

blazor/markdown-editor/accessibility.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -41,24 +41,24 @@ The accessibility compliance for the Blazor Markdown Editor component is outline
4141

4242
## WAI-ARIA attributes
4343

44-
* The toolbar of Blazor Markdown Editor, assigned the role of `Toolbar` and has the following list of [WAI-ARIA](https://www.w3.org/WAI/ARIA/apg/patterns/) attribute.
44+
The toolbar in the Blazor Markdown Editor is assigned the role of `toolbar` and includes the following [WAI-ARIA](https://www.w3.org/WAI/ARIA/apg/patterns/) attribute.
4545

4646
| **Property** | **Functionalities** |
4747
| --- | --- |
48-
| role="toolbar" | This attribute added to the ToolBar element describes the actual role of the element. |
49-
| aria-orientation | Indicates the ToolBar orientation. Default value is `horizontal`. |
50-
| aria-haspopup | Indicates the popup mode of the Toolbar. Default value is false. When popup mode is enabled, attribute value has to be changed to `true`. | |
51-
| aria-disabled | Indicates the disabled state of the ToolBar. |
52-
| aria-owns | Identifies an element to define a visual, functional, or contextual parent/child relationship between DOM elements when the DOM hierarchy cannot represent the relationship. In the Markdown Editor, the attribute contains the ID of the Markdown Editor to indicate the popup as a child element. |
48+
| `role="toolbar"` | Describes the actual role of the toolbar element. |
49+
| `aria-orientation` | Indicates the toolbar orientation. Default is `horizontal`. |
50+
| `aria-haspopup` | Indicates whether the toolbar has a popup. Default is `false`. Set to `true` wwhen popup mode is enabled. |
51+
| `aria-disabled` | Indicates the disabled state of the toolbar. |
52+
| `aria-owns` | Identifies an element to define a visual, functional, or contextual parent/child relationship between DOM elements when the DOM hierarchy cannot represent the relationship. In the Markdown Editor, the attribute contains the ID of the Markdown Editor to indicate the popup as a child element. |
5353

54-
For further details of Toolbar ARIA attributes, refer the [`accessibility of Toolbar`](../../toolbar/accessibility) documentation.
54+
or more information about toolbar ARIA attributes, refer to the [accessibility of Toolbar](https://blazor.syncfusion.com/documentation/toolbar/accessibility) documentation.
5555

56-
The Blazor Markdown Editor element is assigned the role of `application`.
56+
The Blazor Markdown Editor element is assigned the role of `application`:
5757

5858
| **Property** | **Functionalities** |
5959
| --- | --- |
60-
| role="application" | This attribute added to the Markdown Editor element describes the actual role of the element. |
61-
| aria-disabled | Indicates the disabled state of the ToolBar. |
60+
| `role="application"`| Describes the actual role of the Markdown Editor element. |
61+
| `aria-disabled` | Indicates the disabled state of the toolbar. |
6262

6363
{% tabs %}
6464
{% highlight cshtml %}
@@ -72,13 +72,13 @@ The Blazor Markdown Editor element is assigned the role of `application`.
7272

7373
## Keyboard interaction
7474

75-
The Blazor Markdown Editor component followed the [keyboard interaction](https://www.w3.org/WAI/ARIA/apg/patterns/alert/#keyboardinteraction) guideline, making it easy for people who use assistive technologies (AT) and those who completely rely on keyboard navigation. The following keyboard shortcuts are supported by the Markdown Editor component. 
75+
The Blazor Markdown Editor component follows the [keyboard interaction](https://www.w3.org/WAI/ARIA/apg/patterns/alert/#keyboardinteraction) guidelines, making it easy for people who use assistive technologies (AT) and those who completely rely on keyboard navigation. The following keyboard shortcuts are supported by the Markdown Editor component. 
7676

7777
For more details on keyboard navigation, refer to the [Keyboard support](https://blazor.syncfusion.com/documentation/rich-text-editor/keyboard-support) documentation.
7878

7979
## Ensuring accessibility
8080

81-
The Blazor Markdown Editor component's accessibility levels are ensured through an [axe-core](https://www.npmjs.com/package/axe-core) software tool during automated testing.
81+
Accessibility levels are validated using the[axe-core](https://www.npmjs.com/package/axe-core) software tool during automated testing.
8282

8383
The accessibility compliance of the Markdown Editor component is shown in the following sample. Open the [sample](https://blazor.syncfusion.com/accessibility/rich-text-editor) in a new window to evaluate the accessibility of the Markdown Editor component with accessibility tools.
8484

@@ -101,4 +101,4 @@ N> You can refer to our [Blazor Rich Text Editor](https://www.syncfusion.com/bla
101101

102102
## See also
103103

104-
* [Accessibility in Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components](../common/accessibility)
104+
* [Accessibility in Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components](../common/accessibility)

blazor/markdown-editor/custom-format.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
11
---
22
layout: post
33
title: Customize Markdown Syntax in Blazor Markdown Editor | Syncfusion
4-
description: Checkout and learn here all about Customizing Markdown Syntax in Syncfusion Blazor Markdown Editor component and more.
4+
description: Learn how to customize Markdown syntax in the Syncfusion Blazor Markdown Editor component, including formatting options, toolbar customization, and more.
55
platform: Blazor
66
control: MarkdownEditor
77
documentation: ug
88
---
99

1010
# Customizing Markdown Syntax in Blazor Markdown Editor Component
1111

12-
The Rich Text Editor allows you to customize the markdown syntax by overriding its default syntax. Configure the customized markdown syntax using [RichTextEditorMarkdownOptions.ListSyntax](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.RichTextEditor.RichTextEditorMarkdownOptions.html#Syncfusion_Blazor_RichTextEditor_RichTextEditorMarkdownOptions_ListSyntax), [RichTextEditorMarkdownOptions.FormatSyntax](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.RichTextEditor.RichTextEditorMarkdownOptions.html#Syncfusion_Blazor_RichTextEditor_RichTextEditorMarkdownOptions_FormatSyntax), [RichTextEditorMarkdownOptions.SelectionSyntax](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.RichTextEditor.RichTextEditorMarkdownOptions.html#Syncfusion_Blazor_RichTextEditor_RichTextEditorMarkdownOptions_SelectionSyntax) properties.
12+
The Rich Text Editor allows you to customize the Markdown syntax by overriding its default behavior. You can configure custom Markdown syntax using the following properties:
13+
- [RichTextEditorMarkdownOptions.ListSyntax](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.RichTextEditor.RichTextEditorMarkdownOptions.html#Syncfusion_Blazor_RichTextEditor_RichTextEditorMarkdownOptions_ListSyntax)
14+
- [RichTextEditorMarkdownOptions.FormatSyntax](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.RichTextEditor.RichTextEditorMarkdownOptions.html#Syncfusion_Blazor_RichTextEditor_RichTextEditorMarkdownOptions_FormatSyntax)
15+
- [RichTextEditorMarkdownOptions.SelectionSyntax](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.RichTextEditor.RichTextEditorMarkdownOptions.html#Syncfusion_Blazor_RichTextEditor_RichTextEditorMarkdownOptions_SelectionSyntax)
1316

14-
## Defining Custom Markdown Formatting
17+
## Defining Custom Markdown Formatting
1518

16-
You can define custom symbols for different Markdown formatting options:
19+
You can define custom symbols for various Markdown formatting options:
1720

1821
* Use `+` for unordered lists instead of `-`.
1922
* Use `__text__` for bold text instead of `**text**`.
@@ -33,4 +36,4 @@ The following example demonstrates how to customize Markdown tags in the editor:
3336

3437
![Blazor RichTextEditor markdown custom format](./images/blazor-richtexteditor-markdown-custom-formats.png)
3538

36-
![Blazor RichTextEditor markdown custom selection](./images/blazor-richtexteditor-markdown-custom-bold.png)
39+
![Blazor RichTextEditor markdown custom selection](./images/blazor-richtexteditor-markdown-custom-bold.png)

blazor/markdown-editor/getting-started-webapp.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ documentation: ug
99

1010
# Getting Started with Blazor Markdown Editor in Blazor Web App
1111

12-
This section briefly explains about how to include [Blazor Rich Text Editor](https://www.syncfusion.com/blazor-components/blazor-wysiwyg-rich-text-editor) component in your Blazor Web App using [Visual Studio](https://visualstudio.microsoft.com/vs/) and Visual Studio Code.
12+
This section explains how to integrate [Blazor Rich Text Editor](https://www.syncfusion.com/blazor-components/blazor-wysiwyg-rich-text-editor) component in your Blazor Web App using [Visual Studio](https://visualstudio.microsoft.com/vs/) and Visual Studio Code.
1313

1414
{% tabcontents %}
1515

@@ -29,7 +29,7 @@ You need to configure the corresponding [Interactive render mode](https://learn.
2929

3030
To add **Blazor Markdown Editor** component in the app, open the NuGet package manager in Visual Studio (*Tools → NuGet Package Manager → Manage NuGet Packages for Solution*), search and install [Syncfusion.Blazor.RichTextEditor](https://www.nuget.org/packages/Syncfusion.Blazor.RichTextEditor) and [Syncfusion.Blazor.Themes](https://www.nuget.org/packages/Syncfusion.Blazor.Themes/).
3131

32-
If you utilize `WebAssembly or Auto` render modes in the Blazor Web App need to be install Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components NuGet packages within the client project.
32+
If you utilize `WebAssembly or Auto` render modes in the Blazor Web App need to install Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor component NuGet packages in the client project.
3333

3434
Alternatively, you can utilize the following package manager command to achieve the same.
3535

@@ -74,7 +74,7 @@ N> For more information on creating a **Blazor Web App** with various interactiv
7474

7575
## Install Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor RichTextEditor and Themes NuGet in the App
7676

77-
If you utilize `WebAssembly` or `Auto` render modes in the Blazor Web App need to be install Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor components NuGet packages within the client project.
77+
If you utilize `WebAssembly` or `Auto` render modes in the Blazor Web App need to install Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor component NuGet packages in the client project.
7878

7979
* Press <kbd>Ctrl</kbd>+<kbd>`</kbd> to open the integrated terminal in Visual Studio Code.
8080
* Ensure you’re in the project root directory where your `.csproj` file is located.
@@ -207,7 +207,7 @@ N> If an **Interactivity Location** is set to `Global` and the **Render Mode** i
207207
{% tabs %}
208208
{% highlight razor %}
209209

210-
@* desired render mode define here *@
210+
@* Define the desired render mode here *@
211211
@rendermode InteractiveAuto
212212

213213
{% endhighlight %}
@@ -220,7 +220,7 @@ N> If an **Interactivity Location** is set to `Global` and the **Render Mode** i
220220

221221
@code {
222222
private string MarkdownValue { get; set; } = @"In Rich Text Editor, you click the toolbar buttons to format the words and
223-
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. Rich Text Editor supports markdown editing when the editorMode set as **markdown** and using both *keyboard interaction* and *toolbar action*, you can apply the formatting to text. You 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.";
223+
the changes are visible immediately. In contrast, Markdown requires syntax to indicate formatting. 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. Rich Text Editor supports markdown editing when the editorMode set as **markdown** and using both *keyboard interaction* and *toolbar action*, you can apply the formatting to text. You can add your own custom formatting 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.";
224224

225225
}
226226

@@ -245,7 +245,7 @@ Configure the toolbar with the tools using [RichTextEditorToolbarSettings.Items]
245245
@code {
246246

247247
private string MarkdownValue { get; set; } = @"In Rich Text Editor, you click the toolbar buttons to format the words and
248-
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. Rich Text Editor supports markdown editing when the editorMode set as **markdown** and using both *keyboard interaction* and *toolbar action*, you can apply the formatting to text. You 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.";
248+
the changes are visible immediately. In contrast, Markdown requires syntax to indicate formatting. 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. Rich Text Editor supports markdown editing when the editorMode set as **markdown** and using both *keyboard interaction* and *toolbar action*, you can apply the formatting to text. You can add your own custom formatting 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.";
249249

250250
private List<ToolbarItemModel> Tools = new List<ToolbarItemModel>()
251251
{
@@ -305,7 +305,7 @@ To retrieve the contents of the Markdown editor, use the [Value](https://help.sy
305305
private bool Visibility = false;
306306
private string Header = "Markdown Editor Value";
307307
private string RteValue = @" In Rich Text Editor, you click the toolbar buttons to format the words and
308-
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. Rich Text Editor supports markdown editing when the editorMode set as **markdown** and using both *keyboard interaction* and *toolbar action*, you can apply the formatting to text. You 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.";
308+
the changes are visible immediately. In contrast, Markdown requires syntax to indicate formatting. 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. Rich Text Editor supports markdown editing when the editorMode set as **markdown** and using both *keyboard interaction* and *toolbar action*, you can apply the formatting to text. You can add your own custom formatting 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.";
309309
private async Task GetValue()
310310
{
311311
this.Content = this.RteValue;
@@ -350,7 +350,7 @@ To retrieve the maximum number of characters in the Markdown Editor's content, u
350350
private bool Visibility = false;
351351
private string Header = "Rich Text Editor's Value";
352352
private string RteValue = @"In Rich Text Editor, you click the toolbar buttons to format the words and
353-
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. Rich Text Editor supports markdown editing when the editorMode set as **markdown** and using both *keyboard interaction* and *toolbar action*, you can apply the formatting to text. You 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.";
353+
the changes are visible immediately. In contrast, Markdown requires syntax to indicate formatting. 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. Rich Text Editor supports markdown editing when the editorMode set as **markdown** and using both *keyboard interaction* and *toolbar action*, you can apply the formatting to text. You can add your own custom formatting 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.";
354354
private async Task GetCharCount()
355355
{
356356
double charCount = await this.RteObj.GetCharCountAsync();

blazor/markdown-editor/insert-image.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,19 @@ control: MarkdownEditor
77
documentation: ug
88
---
99

10-
# Insert Images in Blazor Markdown Editor Component
10+
# How to Insert Images in Blazor Markdown Editor Component
1111

12-
The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Markdown Editor allows users to insert images using the toolbar. This feature enables embedding images from online sources into the editor content.
12+
The Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Markdown Editor allows users to insert images using the built-in toolbar. This feature supports embedding images from online sources directly into the editor content.
1313

14-
## Steps to Insert an Image
14+
## Steps to Insert an Image
1515

16-
Follow these steps to add an image in the Markdown editor:
16+
To insert an image in the Markdown Editor:
1717

1818
1. Click the [Image](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.RichTextEditor.RichTextEditorImageSettings.html) icon in the toolbar.
1919
2. Enter the **URL** of the image from an online source.
2020
3. Click the **Insert** button in the image dialog.
2121

22-
The image will be added to the editor content at the cursor position.
22+
The image will be added to the editor content at the current cursor position.
2323

2424
The following example demonstrates how to enable image insertion in the Syncfusion<sup style="font-size:70%">&reg;</sup> Blazor Markdown Editor.
2525

@@ -31,4 +31,4 @@ The following example demonstrates how to enable image insertion in the Syncfusi
3131
{% endhighlight %}
3232
{% endtabs %}
3333

34-
![Blazor Markdown Editor markdown image](./images/blazor-markdowneditor-markdown-image.png)
34+
![Image insertion using Blazor Markdown Editor toolbar](./images/blazor-markdowneditor-markdown-image.png)

0 commit comments

Comments
 (0)