Skip to content

Commit 64d66c0

Browse files
committed
DOC-2996: Update Markdown plugin documentation for clarity and accuracy
1 parent 24c09f9 commit 64d66c0

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

modules/ROOT/pages/markdown.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,18 @@
99

1010
include::partial$misc/admon-premium-plugin.adoc[]
1111

12-
The {pluginname} Premium plugin detects pure {pluginname} from a paste event within a {productname} editor instance.
12+
The {pluginname} Premium plugin detects pure markdown from a paste event within a {productname} editor instance.
1313

1414
== Using the {pluginname} plugin
1515

1616
=== How it works
1717

18-
The **{pluginname}** Premium Plugin detects if pure {pluginname} 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-
If {pluginname} content is detected during a paste event, the editor will:
20+
If markdown content is detected during a paste event, the editor will:
2121

22-
* Attempt to convert the {pluginname} into HTML
23-
* Add an undo level before the conversion, allowing the original plain text to be restored
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
====
@@ -31,7 +31,7 @@ To paste text without formatting use:
3131
* *Windows*: `Ctrl+Shift+V`.
3232
* *Mac*: `Cmd+Shift+V`.
3333
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.
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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
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

33
The API converts the current {productname} document from HTML into valid {pluginname} syntax.
44

0 commit comments

Comments
 (0)