diff --git a/modules/ROOT/pages/markdown.adoc b/modules/ROOT/pages/markdown.adoc index 89888d2b72..0d3ddd9227 100644 --- a/modules/ROOT/pages/markdown.adoc +++ b/modules/ROOT/pages/markdown.adoc @@ -15,23 +15,23 @@ The {pluginname} Premium plugin detects pure markdown from a paste event within === How it works -The **Markdown** Premium Plugin allows the editor to detect if pure markdown is pasted into the {productname} editor instance. +The **{pluginname}** Premium Plugin detects if pure markdown is pasted into the {productname} editor instance. -During this paste event, If the editor detects markdown has been pasted it will: +If markdown content is detected during a paste event, the editor will: -* attempt to convert the markdown to HTML, while -* add a undo level before the conversion to allow for undo of plain-text. +* attempt to convert the markdown into HTML +* add an undo level before the conversion, allowing the original plain text to be restored [TIP] ==== -Below is a list of handy shortcuts for pasting in `plain-text` format when using the {pluginname} plugin within {productname}. +Below are useful keyboard shortcuts for pasting in `plain-text` format when using the {pluginname} plugin within {productname}. -To paste text in plain form using keyboard shortcuts, use: +To paste text without formatting use: * *Windows*: `Ctrl+Shift+V`. * *Mac*: `Cmd+Shift+V`. -These shortcuts allow pasting of `plain-text` without formatting, particularly when copying markdown syntax (text) from websites or documents. If the user copied text from one source with certain formatting (such as bold, italics, or different fonts), using this command will paste the text into the new location without carrying over the original formatting. +These shortcuts allow pasting of `plain-text` which removes existing formatting (such as bold, italics, or different fonts). This is particularly useful when copying {pluginname} syntax (text) from websites or documents as it ensures the text is pasted into the new location without the original HTML formatting. ==== == Basic setup diff --git a/modules/ROOT/partials/plugin-apis/markdown-apis.adoc b/modules/ROOT/partials/plugin-apis/markdown-apis.adoc index 441827b6a2..df29a01a1b 100644 --- a/modules/ROOT/partials/plugin-apis/markdown-apis.adoc +++ b/modules/ROOT/partials/plugin-apis/markdown-apis.adoc @@ -1,6 +1,6 @@ -A new API, `editor.plugins.markdown.getContent();` has been added to support the new {pluginname} plugin +The editor.plugins.markdown.getContent() API supports the {pluginname} plugin. -The API's function is to take a {productname} document, and processes it such that the previously HTML content is converted into content with valid {pluginname} syntax. +The API converts the current {productname} document from HTML into valid {pluginname} syntax. The `editor.plugins.markdown.getContent();` API does not require configuration from the user