Skip to content

Commit 4617fb6

Browse files
authored
* DOC-2996: Updte Markdown plugin documentation for clarity and accuracy * DOC-2996: Update Markdown plugin documentation for clarity and accuracy
1 parent 78c7b5f commit 4617fb6

2 files changed

Lines changed: 9 additions & 9 deletions

File tree

modules/ROOT/pages/markdown.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,23 +15,23 @@ The {pluginname} Premium plugin detects pure markdown from a paste event within
1515

1616
=== How it works
1717

18-
The **Markdown** Premium Plugin allows the editor to detect if pure markdown is pasted into the {productname} editor instance.
18+
The **{pluginname}** Premium Plugin detects if pure markdown is pasted into the {productname} editor instance.
1919

20-
During this paste event, If the editor detects markdown has been pasted it will:
20+
If markdown content is detected during a paste event, the editor will:
2121

22-
* attempt to convert the markdown to HTML, while
23-
* add a undo level before the conversion to allow for undo of plain-text.
22+
* attempt to convert the markdown into HTML
23+
* add an undo level before the conversion, allowing the original plain text to be restored
2424

2525
[TIP]
2626
====
27-
Below is a list of handy shortcuts for pasting in `plain-text` format when using the {pluginname} plugin within {productname}.
27+
Below are useful keyboard shortcuts for pasting in `plain-text` format when using the {pluginname} plugin within {productname}.
2828
29-
To paste text in plain form using keyboard shortcuts, use:
29+
To paste text without formatting use:
3030
3131
* *Windows*: `Ctrl+Shift+V`.
3232
* *Mac*: `Cmd+Shift+V`.
3333
34-
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.
34+
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.
3535
====
3636

3737
== Basic setup

modules/ROOT/partials/plugin-apis/markdown-apis.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
A new API, `editor.plugins.markdown.getContent();` has been added to support the new {pluginname} plugin
1+
The editor.plugins.markdown.getContent() API supports the {pluginname} plugin.
22

3-
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.
3+
The API converts the current {productname} document from HTML into valid {pluginname} syntax.
44

55
The `editor.plugins.markdown.getContent();` API does not require configuration from the user
66

0 commit comments

Comments
 (0)