<p>The Markdown Premium plugin detects pure markdown from a paste event within a TinyMCE editor instance.</p>
<h1>Markdown Premium Plugin</h1>
<p>The <strong>Markdown Premium Plugin</strong> enhances the functionality of the editor by allowing it to detect and convert pure markdown content on-paste.</p>
<h2><strong>Tips for Pasting Text</strong></h2>
<p>To paste text in plain form using keyboard shortcuts, use:</p>
<ul>
<li><strong>Windows:</strong> Ctrl+Shift+V</li>
<li><strong>Mac:</strong> Cmd+Shift+V</li>
</ul>
<h3>Paste Example</h3>
<p>Paste the following markdown into the editor using the above shortcuts:</p>
If you are using {productname} in a self-hosted environment, a console log warning message will display if the license key config option is missing or invalid. This message aims to ensure compliance with licensing requirements and provide transparency during the evaluation period.
This message will not be shown when loading {productname} from the Tiny Cloud, as it is already under a commercial license.
This message will not be shown when loading {productname} from {cloudname}, as it is already under a commercial license.
====
== Setting the license
=== Use {productname} with the GPLv2+ license:
If the developer intends to self-host {productname} under the GPL license, they can set the `license_key` config option to 'gpl'. Case sensitivity does not matter.
==== Example
[source,js]
----
tinymce.init({
selector: 'textarea', // change this value according to your HTML
license_key: 'gpl'
});
----
=== Use {productname} with a commercial license:
If the developer intends to self-host {productname} under a commercial license, they must provide a valid license key. Customers who have purchased a self-hosted-eligible license for {productname} will find their license key in the account portal. To purchase a commercial license, see available options on the link:{pricingpage}/[pricing page].
==== Example
[source,js]
----
tinymce.init({
selector: 'textarea', // change this value according to your HTML
license_key: '<your-license-key>'
});
----
include::partial$misc/setting-the-license.adoc[]
== FAQ
@ -52,7 +24,7 @@ The GPLv2+ license was chosen to provide the best compatibility with existing GP
=== What is the difference between a license key and the API key?
The **API key** is used when loading {productname} from the Tiny Cloud. The **license key** is used to declare the license terms when self-hosting {productname}.
The **API key** is used when loading {productname} from the {cloudname}. The **license key** is used to declare the license terms when self-hosting {productname}.
=== Who needs to get a license key?
@ -64,7 +36,7 @@ If {productname} detects that the `license_key` configuration is missing or inva
=== Should I be using both an API key and a license key?
No, an API key and a license key should not be used simultaneously. The API key should only be used if {productname} is loaded from the Tiny Cloud. If {productname} is being self-hosted, the license key option should be used instead.
No, an API key and a license key should not be used simultaneously. The API key should only be used if {productname} is loaded from the {cloudname}. If {productname} is being self-hosted, the license key option should be used instead.
=== Will {productname} “phone home” to check the license key?
{productname} {productmajorversion} is a powerful and flexible rich text editor that can be embedded in web applications. This quick start covers how to add a {productname} editor to a web page using {sourcename}.
@ -91,14 +91,14 @@ To add {productname} to a .NET project, run the following on a command line:
+
[source,sh]
----
Install-Package TinyMCE
Install-Package {productname}
----
* Using the `+dotnet+` CLI, run the following:
+
[source,sh]
----
dotnet add package TinyMCE
dotnet add package {productname}
----
Ensure the `+tinymce+` directory containing the `+tinymce.min.js+` file is accessible for the target page or application by either:
@ -123,7 +123,7 @@ The location of the main {productname} script will be: `+/path/to/webserver/publ
endif::[]
== Include the TinyMCE script
== Include the {productname} script
Include the following line of code in the `+<head>+` of an HTML page.
@ -132,7 +132,7 @@ Include the following line of code in the `+<head>+` of an HTML page.
Initialize {productname} {productmajorversion} on any element (or elements) on the web page by passing an object containing a `+selector+` value to `+tinymce.init()+`. The `+selector+` value can be any valid https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors[CSS selector].
@ -140,6 +140,7 @@ For example: To replace `+<textarea id="mytextarea">+` with a {productname} {pro
Adding this content to an HTML file and opening it in a web browser will load a TinyMCE editor, such as:
Adding this content to an HTML file and opening it in a web browser will load a {productname} editor, such as:
liveDemo::default[]
ifeval::["{productSource}" == "cloud"]
ifeval::["{productSource}" == "cloud"]
== Add your API key
To remove the notice:
@ -181,6 +211,12 @@ Replace `+no-api-key+` in the source script (`+<script src=...+`) with a {cloudn
Signing up for a {cloudname} API key will also provide a trial of the xref:plugins.adoc#premium-plugins[Premium Plugins].
endif::[]
ifeval::["{productSource}" != "cloud"]
include::partial$misc/setting-the-license.adoc[]
For more information on licensing, see the xref:license-key.adoc[License Key] guide.
endif::[]
== Save the content from the editor
To retrieve content from the editor, either process the content with a form handler or use the xref:apis/tinymce.editor.adoc#getContent[getContent API].
If the developer intends to self-host {productname} under the GPL license, they can set the `license_key` config option to 'gpl'. Case sensitivity does not matter.
==== Example
[source,js]
----
tinymce.init({
selector: 'textarea', // change this value according to your HTML
license_key: 'gpl'
});
----
=== Use {productname} with a commercial license
If the developer intends to self-host {productname} under a commercial license, a valid license key must be provided. Customers who have purchased a self-hosted-eligible license for {productname} will find their license key in the link:https://www.tiny.cloud/auth/login/[account portal]. To purchase a commercial license, see available options on the link:{pricingpage}/[pricing page].
==== Example
[source,js]
----
tinymce.init({
selector: 'textarea', // change this value according to your HTML
Farzad Hayatbakhsh
1 year ago