Skip to content

Documentation enhancements: for https://www.tiny.cloud/docs/tinymce/latest/markdown/ #4104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jeslynbo wants to merge 1 commit into
base: tinymce/8
Choose a base branch
from
+9 −9
Open

Documentation enhancements: for https://www.tiny.cloud/docs/tinymce/latest/markdown/ #4104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions modules/ROOT/pages/markdown.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,29 +9,29 @@

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

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

== Using the {pluginname} plugin

=== 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 {pluginname} is pasted into the {productname} editor instance.

During this paste event, If the editor detects markdown has been pasted it will:
If {pluginname} 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 {pluginname} 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
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/partials/plugin-apis/markdown-apis.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
A new API, `editor.plugins.markdown.getContent();` has been added to support the new {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

Expand Down
Loading