Skip to content

Commit

Permalink
HtmlEditor: remove Markdown support mentions (#6792)
Browse files Browse the repository at this point in the history
  • Loading branch information
vladaskorohodova authored Nov 7, 2024
1 parent 91c3d94 commit 7d91d44
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 15 deletions.
3 changes: 1 addition & 2 deletions api-reference/10 UI Components/dxHtmlEditor/dxHtmlEditor.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@ inherits: Editor
---
---
##### shortDescription
HtmlEditor is a WYSIWYG editor that allows you to format textual and visual content and to output it in HTML or Markdown. HtmlEditor is built on top of and requires the <a href="https://github.com/DevExpress/devextreme-quill/" target="_blank">DevExtreme Quill</a>.
HtmlEditor is a WYSIWYG editor that allows you to format textual and visual content and to output it in HTML. HtmlEditor is built on top of and requires the <a href="https://github.com/DevExpress/devextreme-quill/" target="_blank">DevExtreme Quill</a>.

##### widgettree
valueType: "html",
value: "This is <b>HtmlEditor</b>.<br/>Select text and use a toolbar item.",
toolbar: {
items: ["bold", "italic", "color", "background", "link",
Expand Down
3 changes: 1 addition & 2 deletions applications/GettingStartedWith/HtmlEditor/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ <h2>
Rich Text Editor (HTML Editor)
</h2>
<br>
<p>DevExtreme JavaScript HTML Editor is a client-side WYSIWYG editor that allows its users to format textual and visual content and output it as HTML or Markdown.</p>
<p>DevExtreme JavaScript HTML Editor is a client-side WYSIWYG editor that allows its users to format textual and visual content and output it as HTML.</p>
<p>Supported features:</p>
<ul>
<li>Inline formats:
Expand All @@ -22,7 +22,6 @@ <h2>
</ul>
</li>
<li>Built-in format customization</li>
<li>HTML and Markdown support</li>
<li>Mail Merge</li>
<li>Adaptive toolbar for working with images, links, and color formats</li>
<li>Copy-paste rich content (the control strips unsupported formats)</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ Refer to the following sections for details on each configuration step. You can
href: "https://github.com/DevExpress-Examples/getting-started-with-devextreme-htmleditor"
}

[tags] dxHtmlEdtior, rich text editor, markdown editor
[tags] dxHtmlEdtior, rich text editor
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The control stores the document markup in the [value](/api-reference/10%20UI%20C
Rich Text Editor (HTML Editor)
</h2>
<br>
<p>DevExtreme JavaScript HTML Editor is a client-side WYSIWYG text editor that allows its users to format textual and visual content and store it as HTML or Markdown.</p>
<p>DevExtreme JavaScript HTML Editor is a client-side WYSIWYG text editor that allows its users to format textual and visual content and store it as HTML.</p>
<p>Supported features:</p>
<ul>
<li>Inline formats:
Expand All @@ -33,7 +33,6 @@ The control stores the document markup in the [value](/api-reference/10%20UI%20C
</ul>
</li>
<li>Built-in format customization</li>
<li>HTML and Markdown support</li>
<li>Mail Merge</li>
<li>Adaptive toolbar for working with images, links, and color formats</li>
<li>Copy-paste rich content (the control strips unsupported formats)</li>
Expand Down Expand Up @@ -102,7 +101,7 @@ To update the value at the runtime, call the [option(optionName, optionValue)](/
Rich Text Editor (HTML Editor)
</h2>
<br>
<p>DevExtreme JavaScript HTML Editor is a client-side WYSIWYG editor that allows its users to format textual and visual content and output it as HTML or Markdown.</p>
<p>DevExtreme JavaScript HTML Editor is a client-side WYSIWYG editor that allows its users to format textual and visual content and output it as HTML.</p>
<p>Supported features:</p>
<ul>
<li>Inline formats:
Expand All @@ -120,7 +119,6 @@ To update the value at the runtime, call the [option(optionName, optionValue)](/
</ul>
</li>
<li>Built-in format customization</li>
<li>HTML and Markdown support</li>
<li>Mail Merge</li>
<li>Adaptive toolbar for working with images, links, and color formats</li>
<li>Copy-paste rich content (the control strips unsupported formats)</li>
Expand Down Expand Up @@ -175,7 +173,7 @@ To update the value at the runtime, call the [option(optionName, optionValue)](/
Rich Text Editor (HTML Editor)
</h2>
<br>
<p>DevExtreme JavaScript HTML Editor is a client-side WYSIWYG text editor that allows its users to format textual and visual content and store it as HTML or Markdown.</p>
<p>DevExtreme JavaScript HTML Editor is a client-side WYSIWYG text editor that allows its users to format textual and visual content and store it as HTML.</p>
<p>Supported features:</p>
<ul>
<li>Inline formats:
Expand All @@ -193,7 +191,6 @@ To update the value at the runtime, call the [option(optionName, optionValue)](/
</ul>
</li>
<li>Built-in format customization</li>
<li>HTML and Markdown support</li>
<li>Mail Merge</li>
<li>Adaptive toolbar for working with images, links, and color formats</li>
<li>Copy-paste rich content (the control strips unsupported formats)</li>
Expand Down Expand Up @@ -254,7 +251,7 @@ To update the value at the runtime, call the [option(optionName, optionValue)](/
Rich Text Editor (HTML Editor)
</h2>
<br>
<p>DevExtreme JavaScript HTML Editor is a client-side WYSIWYG text editor that allows its users to format textual and visual content and store it as HTML or Markdown.</p>
<p>DevExtreme JavaScript HTML Editor is a client-side WYSIWYG text editor that allows its users to format textual and visual content and store it as HTML.</p>
<p>Supported features:</p>
<ul>
<li>Inline formats:
Expand All @@ -272,7 +269,6 @@ To update the value at the runtime, call the [option(optionName, optionValue)](/
</ul>
</li>
<li>Built-in format customization</li>
<li>HTML and Markdown support</li>
<li>Mail Merge</li>
<li>Adaptive toolbar for working with images, links, and color formats</li>
<li>Copy-paste rich content (the control strips unsupported formats)</li>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
HtmlEditor is a client-side WYSIWYG editor that allows users to format text and visual content, and to export it as HTML or Markdown. HtmlEditor supports browser spellcheck functionality.
HtmlEditor is a client-side WYSIWYG editor that allows users to format text and visual content, and to export it as HTML. HtmlEditor supports browser spellcheck functionality.

In this overview, you can find a map of HtmlEditor elements, information about key features, and what to explore next.
2 changes: 1 addition & 1 deletion concepts/05 UI Components/HtmlEditor/90 Limitations.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
HtmlEditor is designed to create rich text and export it in HTML or Markdown format. You can also use the component to parse HTML content (for example, if you set [value](/api-reference/10%20UI%20Components/dxHtmlEditor/1%20Configuration/value.md '/Documentation/ApiReference/UI_Components/dxHtmlEditor/Configuration/#value') to markup). However, this technique may prove ineffective because HtmlEditor does not support all HTML features. The following limitations apply:
HtmlEditor is designed to create rich text and export it in HTML. You can also use the component to parse HTML content (for example, if you set [value](/api-reference/10%20UI%20Components/dxHtmlEditor/1%20Configuration/value.md '/Documentation/ApiReference/UI_Components/dxHtmlEditor/Configuration/#value') to markup). However, this technique may prove ineffective because HtmlEditor does not support all HTML features. The following limitations apply:

- If you use <a href="https://developer.mozilla.org/en-US/docs/Web/API/Web_components/Using_shadow_DOM" target="_blank">Shadow DOM</a>, the HtmlEditor component may experience issues in some browsers (see <a href="https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot#browser_compatibility" target="_blank">getSelection</a>).

Expand Down

0 comments on commit 7d91d44

Please sign in to comment.