From 17da21398b5a85e25ebe5dda55a438697ef23d7a Mon Sep 17 00:00:00 2001 From: Witek Socha Date: Tue, 12 Nov 2024 18:43:35 +0100 Subject: [PATCH 1/8] Add evaluation license description. --- .../licensing/license-key-and-activation.md | 29 +++++++++++++------ packages/ckeditor5-core/src/editor/editor.ts | 1 + 2 files changed, 21 insertions(+), 9 deletions(-) diff --git a/docs/getting-started/licensing/license-key-and-activation.md b/docs/getting-started/licensing/license-key-and-activation.md index 2c6ebd9e777..36fa687741d 100644 --- a/docs/getting-started/licensing/license-key-and-activation.md +++ b/docs/getting-started/licensing/license-key-and-activation.md @@ -106,9 +106,9 @@ This key grants access to **all features**. It is valid for **14 days**. It does * **Features**: Grants access to all features and add-ons. * **Duration**: Valid for 14 days (until 12th May 2024). * **Functionality**: The editor is limited functionally, such as session time and the number of changes allowed. -* **Intended Use**: Ideal for evaluating the platform and all its features. -* **Usage Limitation**: Can only be used for evaluation purposes and not for production. -* **Editor Loads**: Does not consume editor loads. +* **Intended use**: Ideal for evaluating the platform and all its features. +* **Usage limitation**: Can only be used for evaluation purposes and not for production. +* **Editor loads**: Does not consume editor loads. You can sign up for the [CKEditor Premium Features 14-day free trial](https://portal.ckeditor.com/checkout?plan=free) to test the editor. @@ -121,9 +121,9 @@ This key grants access to your subscription features. It does not consume editor * Similar to the trial license, the editor is limited functionally, including session time and the number of changes allowed. * Additionally, there are limitations on development domains. The editor can be used in the following domains: `localhost`, `*.test`, `*.localhost`, `*.local`, and IP addresses: `127.0.0.1`, `192.168.*.*`, `10.*.*.*`, `172.*.*.*` . * The editor will show a banner informing it was launched for development purposes. -* **Intended Use**: Designed for development environments such as local work, continuous integration (CI), and end-to-end (E2E) tests. -* **Usage Limitation**: Must not be used for production environments. -* **Editor Loads**: Does not consume editor loads. +* **Intended use**: Designed for development environments such as local work, continuous integration (CI), and end-to-end (E2E) tests. +* **Usage limitation**: Must not be used for production environments. +* **Editor loads**: Does not consume editor loads. [Contact us](https://ckeditor.com/contact/?sales=true#contact-form) for more details @@ -133,9 +133,20 @@ This key grants access to your subscription features without imposing any limita * **Features**: Grants access to subscription features. * **Functionality**: The editor functions without any restrictions. -* **Intended Use**: Meant for production environments where the software is actively used by end-users. -* **Usage Limitation**: None specified. -* **Editor Loads**: Consumes editor loads, especially after the 14-day trial period ends. +* **Intended use**: Meant for production environments where the software is actively used by end-users. +* **Usage limitation**: None specified. +* **Editor loads**: Consumes editor loads, especially after the 14-day trial period ends. + +### Evaluation license key + +This license key is a temporary, evaluation-only key generated by our team to support short-term testing and demonstration purposes. It is intended for use in events, sample code, or brief evaluations, allowing limited access to essential platform features. + +* **Features**: Grants access to open-source features only. +* **Duration**: Typically valid for 24 hours to accommodate short-term needs. +* **Functionality**: The editor is limited functionally, such as session time and the number of changes allowed. +* **Intended use**: Ideal for quick evaluations, demos, or inclusion in code samples. +* **Usage limitation**: Issued solely for evaluation purposes by our team; not authorized for production use. +* **Editor loads**: This license does not consume editor loads, ensuring it’s lightweight for temporary testing. ## Using the license key diff --git a/packages/ckeditor5-core/src/editor/editor.ts b/packages/ckeditor5-core/src/editor/editor.ts index 69d626032c7..359db4d45f8 100644 --- a/packages/ckeditor5-core/src/editor/editor.ts +++ b/packages/ckeditor5-core/src/editor/editor.ts @@ -961,6 +961,7 @@ export default abstract class Editor extends /* #__PURE__ */ ObservableMixin() { /** * You have exceeded the editor operation limit available for your evaluation license key. * Please restart the editor to continue using it. + * {@glink getting-started/licensing/license-key-and-activation#license-key-types Read more about license key types}. * * @error license-key-evaluation-limit */ From 5094e3f0eb60088112f388219e3f3ecc1c01fc08 Mon Sep 17 00:00:00 2001 From: Witek Socha Date: Thu, 14 Nov 2024 16:25:03 +0100 Subject: [PATCH 2/8] Improvements to licensing docs. --- .../getting-started/licensing/usage-based-billing.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/getting-started/licensing/usage-based-billing.md b/docs/getting-started/licensing/usage-based-billing.md index 6b2ef969833..06cbcf7e39a 100644 --- a/docs/getting-started/licensing/usage-based-billing.md +++ b/docs/getting-started/licensing/usage-based-billing.md @@ -38,6 +38,12 @@ Alternatively, if you prefer to use only the free, open-source version of CKEdit An editor load occurs each time CKEditor is initialized in your application. For example, if 100 users load CKEditor 10 times each, it results in 1,000 editor loads. +The editor initializes as follows: + +1. The integrator creates one or more editors on a page, typically using a method like `ClassicEditor.create(sourceElementOrData, configuration)`. +2. Depending on the setup, the editor will either initialize with the selected DOM element or, if provided with data, initialize in a detached mode to be added to the DOM on demand. +3. Upon the `ready` event, the editor sends usage information to the server to confirm the license. [Read more about the license check](#license-check-and-usage-data). + Each individual editor instance on a page is counted as one editor load. For example, if a page contains ten editors, a single refresh of that page will result in ten editor loads. Several factors can contribute to a high number of editor loads, with one of the most significant being the use of multiple editors on a single page. For example: @@ -47,6 +53,12 @@ Several factors can contribute to a high number of editor loads, with one of the By understanding these scenarios, you can better anticipate and manage your editor loads to align with your usage plan. +### License check and usage data + +When the editor is ready, a license check request is sent to our server, along with non-personalized data that helps us understand editor usage. This information also assists in resolving any potential dispute claims. + +The server’s response confirms whether the license is valid. If invalid, the editor will switch to read-only mode. + ## How usage-based billing works Each pricing plan includes a specific number of editor loads. If you exceed this limit, you can either upgrade to a higher plan or pay for additional editor loads in blocks of 1,000. From d951385815f45de0cb9accf9364c3f0b0d2fc336 Mon Sep 17 00:00:00 2001 From: Witek Socha Date: Thu, 14 Nov 2024 17:54:04 +0100 Subject: [PATCH 3/8] Update CSP. --- docs/getting-started/setup/csp.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/getting-started/setup/csp.md b/docs/getting-started/setup/csp.md index baedfe13faa..a679c1e3b7c 100644 --- a/docs/getting-started/setup/csp.md +++ b/docs/getting-started/setup/csp.md @@ -9,9 +9,17 @@ order: 110 CKEditor 5 is compatible with applications that use [CSP rules](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP) and helps developers build a secure web. -## Recommended CSP configuration +## Recommended CSP configuration for Cloud deployments -The recommended CSP configuration that allows the rich-text editor to run out–of–the–box with all standard features using the content like images or media from external hosts looks as follows: +The recommended CSP configuration for {@link getting-started/licensing/usage-based-billing#cloud-hosted Cloud deployments} that allows the rich-text editor to run out–of–the–box with all standard features using the content like images or media from external hosts looks as follows: + +``` +default-src 'none'; connect-src 'self'; script-src 'self' https://cdn.ckeditor.com https://proxy-event.ckeditor.com ; img-src * data:; style-src 'self' 'unsafe-inline'; frame-src * +``` + +## Recommended CSP configuration for self-hosted deployments + +The recommended CSP configuration for self-hosted deployments (npm/ZIP) that allows the rich-text editor to run out–of–the–box with all standard features using the content like images or media from external hosts looks as follows: ``` default-src 'none'; connect-src 'self'; script-src 'self'; img-src * data:; style-src 'self' 'unsafe-inline'; frame-src * @@ -29,7 +37,7 @@ Some CSP directives have an impact on certain rich-text editor features. Here is **Note**: To use [CKEditor Cloud Services](https://ckeditor.com/ckeditor-cloud-services/), include the `http://*.cke-cs.com` domain in the `connect-src` directive, for instance: `connect-src 'self' http://*.cke-cs.com`. * `script-src 'self'`: Allows the execution of JavaScript from the current host only and can be applied only if the CKEditor 5 script file (``) is also served from that host. - **Note**: If CKEditor 5 is served from another host, for example the official CDN, make sure the value of `script-src` includes that host (`script-src 'self' https://cdn.ckeditor.com`). + **Note**: If CKEditor 5 is served from {@link getting-started/licensing/usage-based-billing#cloud-hosted Cloud}, make sure the value of `script-src` includes the required hosts, one for the CDN, and one for the license check server: `script-src 'self' https://cdn.ckeditor.com https://proxy-event.ckeditor.com`. * `img-src * data:` * The `*` directive value allows images in the editor content to come from any hosts. * The `data:` value allows: From 52e9fece4dd082cf53701c09584736b4d9376142 Mon Sep 17 00:00:00 2001 From: Witek Socha Date: Thu, 14 Nov 2024 17:58:54 +0100 Subject: [PATCH 4/8] Change the order of the docs. --- docs/getting-started/licensing/license-key-and-activation.md | 2 +- docs/getting-started/licensing/usage-based-billing.md | 2 +- docs/getting-started/setup/csp.md | 2 +- docs/support/license-and-legal.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/getting-started/licensing/license-key-and-activation.md b/docs/getting-started/licensing/license-key-and-activation.md index 36fa687741d..b5e2a51a3ec 100644 --- a/docs/getting-started/licensing/license-key-and-activation.md +++ b/docs/getting-started/licensing/license-key-and-activation.md @@ -1,6 +1,6 @@ --- category: licensing -order: 20 +order: 10 meta-title: License key and activation | CKEditor 5 Documentation meta-description: Managing your license keys and activating the editor. menu-title: License key and activation diff --git a/docs/getting-started/licensing/usage-based-billing.md b/docs/getting-started/licensing/usage-based-billing.md index 06cbcf7e39a..c839010ff24 100644 --- a/docs/getting-started/licensing/usage-based-billing.md +++ b/docs/getting-started/licensing/usage-based-billing.md @@ -3,7 +3,7 @@ category: licensing menu-title: Usage-based billing meta-title: Usage-based billing | CKEditor 5 documentation meta-description: Learn how usage-based billing works in CKEditor 5. -order: 40 +order: 20 modified_at: 2024-10-28 --- diff --git a/docs/getting-started/setup/csp.md b/docs/getting-started/setup/csp.md index a679c1e3b7c..286268cf082 100644 --- a/docs/getting-started/setup/csp.md +++ b/docs/getting-started/setup/csp.md @@ -37,7 +37,7 @@ Some CSP directives have an impact on certain rich-text editor features. Here is **Note**: To use [CKEditor Cloud Services](https://ckeditor.com/ckeditor-cloud-services/), include the `http://*.cke-cs.com` domain in the `connect-src` directive, for instance: `connect-src 'self' http://*.cke-cs.com`. * `script-src 'self'`: Allows the execution of JavaScript from the current host only and can be applied only if the CKEditor 5 script file (``) is also served from that host. - **Note**: If CKEditor 5 is served from {@link getting-started/licensing/usage-based-billing#cloud-hosted Cloud}, make sure the value of `script-src` includes the required hosts, one for the CDN, and one for the license check server: `script-src 'self' https://cdn.ckeditor.com https://proxy-event.ckeditor.com`. + **Note**: If CKEditor 5 is served from {@link getting-started/licensing/usage-based-billing#cloud-hosted Cloud}, make sure the value of `script-src` includes the required hosts, one for the CDN, and one for the {@link getting-started/licensing/usage-based-billing#license-check-and-usage-data license check server}: `script-src 'self' https://cdn.ckeditor.com https://proxy-event.ckeditor.com`. * `img-src * data:` * The `*` directive value allows images in the editor content to come from any hosts. * The `data:` value allows: diff --git a/docs/support/license-and-legal.md b/docs/support/license-and-legal.md index 7180a8cc1b5..962e405e8f5 100644 --- a/docs/support/license-and-legal.md +++ b/docs/support/license-and-legal.md @@ -4,7 +4,7 @@ category: support meta-title: License and legal | CKEditor 5 Documentation -order: 20 +order: 30 --- # License and legal From 9dcfba4766a44b01703e159afd8f3c4d72ab3335 Mon Sep 17 00:00:00 2001 From: Witek Socha Date: Fri, 15 Nov 2024 17:32:05 +0100 Subject: [PATCH 5/8] Changes to license docs. --- .../licensing/license-key-and-activation.md | 85 ++++++++++--------- .../licensing/usage-based-billing.md | 2 +- docs/support/license-and-legal.md | 3 - 3 files changed, 47 insertions(+), 43 deletions(-) diff --git a/docs/getting-started/licensing/license-key-and-activation.md b/docs/getting-started/licensing/license-key-and-activation.md index b5e2a51a3ec..4bae0cd9f4e 100644 --- a/docs/getting-started/licensing/license-key-and-activation.md +++ b/docs/getting-started/licensing/license-key-and-activation.md @@ -9,52 +9,43 @@ modified_at: 2024-10-28 # License key and activation -This article explains how to activate a commercial license for CKEditor 5 and the CKEditor premium features. - -There are two types of premiums: standalone features and services. Standalone ones require a simple license key and include: - -* Asynchronous collaboration features, including: - * {@link features/track-changes Track changes} - * {@link features/comments Comments} - * {@link features/revision-history Revision history} -* {@link features/ai-assistant-overview AI Assistant} -* {@link features/case-change Case change} -* {@link features/document-outline Document outline} -* {@link features/format-painter Format painter} -* {@link features/multi-level-lists Multi-level list} -* {@link features/pagination Pagination} -* {@link features/paste-from-office-enhanced Paste from Office enhanced} -* {@link features/slash-commands Slash commands} -* {@link features/table-of-contents Table of contents} -* {@link features/template Templates} - -Other premium features such as {@link features/real-time-collaboration real-time collaboration}, {@link features/export-word export to Word}, {@link features/export-pdf export to PDF}, or {@link features/import-word import from Word} are authenticated on the server side. +This article explains how to obtain a commercial license for CKEditor 5 and the CKEditor premium features. - CKEditor 5 (without premium features listed above) can be used without activation as {@link getting-started/licensing/license-and-legal open source software under the GPL license}. It will then {@link getting-started/licensing/managing-ckeditor-logo display a small "Powered by CKEditor" logo} in the editor area. + CKEditor 5 without premium features can be used as {@link getting-started/licensing/license-and-legal open source software under the GPL license}. It will then {@link getting-started/licensing/managing-ckeditor-logo display a small "Powered by CKEditor" logo} in the editor area. - For commercial purposes, there are {@link getting-started/licensing/license-and-legal trial, development and production license keys} are available. + If you are not meeting the criteria of the GPL license, you need to obtain a commercial one. ## Obtaining a license -To activate CKEditor 5 and the premium features listed above, you will need either an active commercial license or a trial license. - ### Purchasing a commercial license -If you wish to purchase a commercial CKEditor 5 license, use our [pricing page](https://ckeditor.com/pricing/). You can choose from predefined plans that will allow you to use the editor immediately or you can contact our sales team if you have some specific needs. +If you wish to purchase a commercial CKEditor 5 license there are two options to do that. + +1. Use our [pricing page](https://ckeditor.com/pricing/). You can choose from predefined plans that will allow you to use the editor with our Cloud CDN. +2. [Contact our sales team](https://ckeditor.com/contact/) if you have some specific needs, and you want to use the self-hosted editor. + +### Choosing a distribution method + +When you choose the editor license you need to decide how the editor will be distributed, via cloud or self-hosted. Key differences are: + +- **Cloud-hosted**: Served via our CDN, globally distributed access, no hosting setup required. Subject to {@link getting-started/licensing/usage-based-billing usage-based billing}. +- **Self-hosted**: Setup with npm or ZIP download, offers more flexibility in hosting. This type requires contact with our sales team and a custom plan. ### Subscribing to the CKEditor Premium Features free trial -If you wish to test our offer, you can create an account by [signing up for CKEditor Premium Features 14-day free trial](https://portal.ckeditor.com/signup). After signing up, you will receive access to the Customer Portal. +If you wish to test our offer, you can create an account by [signing up for CKEditor Premium Features 14-day free trial](https://portal.ckeditor.com/checkout?plan=free). After signing up, you will receive access to the Customer Portal. -The trial is commitment-free, and you do not need to provide credit card details to start it. The Premium Features free trial allows you to test all paid CKEditor Ecosystem products at no cost. +The trial is commitment-free, and you do not need to provide credit card details to start it. The Premium Features free trial allows you to test all paid features and products at no cost. + +Trial allows testing both self-hosted and cloud distributions. When the trial finishes, you have to use the distribution according to your plan details. ### Using the GPL license key CKEditor 5 (without the premium features listed above) can be used in an open-source, GPL-compliant setup with: -* a [free account using the Cloud distribution](https://arc.net/l/quote/jyhmkuob). You will be granted a license key and free editor loads. +* a [free account using the Cloud distribution](https://ckeditor.com/pricing). You will be granted a license key and free editor loads. * without account setup as open-source software under the GPL license. Use the `'GPL'` value in the `licenseKey` field in your configuration. In both cases, the editor will {@link getting-started/licensing/managing-ckeditor-logo display a small “Powered by CKEditor” logo} in the editor area. @@ -63,21 +54,28 @@ If you are running an Open Source project under an OSS license incompatible with For commercial purposes, {@link getting-started/licensing/license-and-legal trial, development, and production license keys} are available. -## License key usage +## License key set up Follow this guide to get the license key necessary to create an account and use premium features. ### Create an account -Create an account by [signing up for the CKEditor Premium Features free trial](https://portal.ckeditor.com/checkout?plan=free). After signing up, you will receive access to the customer dashboard (CKEditor Ecosystem dashboard). During the process, you will see a list of features available from the 14-day free trial. You may check the ones you are the most interested in. However, this will not affect the trial package – all of them will be available. +Create an account either by: + +1. [Signing up for the CKEditor Free plan](https://portal.ckeditor.com/checkout?plan=free). +2. Or by choosing [a specific paid plan](https://ckeditor.com/pricing) according to your needs. + +Both options are granted a 14-day trial to test all premium features. + +After signing up, you will receive access to the customer portal. ### Log in to the Customer Portal -Log in to the [CKEditor Ecosystem dashboard](https://dashboard.ckeditor.com/). During the first login, you will receive a confirmation email with a link to create a password for your account. +Log in to the [customer portal](https://portal.ckeditor.com/). During the first login, you will receive a confirmation email with a link to create a password for your account. Keep the password safe, as this trial account will be converted into a commercial account if you decide to buy the license after the trial period is over. -### Access the dashboard +### Access the portal Once logged in, you will have access to all the products available. Please note, that there are two types of premium features: standalone plugins and services. You can access the license keys via the "License keys" and "Cloud environments" sections, respectively. @@ -104,7 +102,7 @@ A token URL and other authentication methods will be assigned to this specific e This key grants access to **all features**. It is valid for **14 days**. It does not consume editor loads, but editor is limited functionally (for example: session time, number of changes). It is **perfect for evaluating the platform** and all its features. It can be used only for evaluation purposes. * **Features**: Grants access to all features and add-ons. -* **Duration**: Valid for 14 days (until 12th May 2024). +* **Duration**: Valid for 14 days. * **Functionality**: The editor is limited functionally, such as session time and the number of changes allowed. * **Intended use**: Ideal for evaluating the platform and all its features. * **Usage limitation**: Can only be used for evaluation purposes and not for production. @@ -119,14 +117,12 @@ This key grants access to your subscription features. It does not consume editor * **Features**: Grants access to subscription features. * **Functionality**: * Similar to the trial license, the editor is limited functionally, including session time and the number of changes allowed. - * Additionally, there are limitations on development domains. The editor can be used in the following domains: `localhost`, `*.test`, `*.localhost`, `*.local`, and IP addresses: `127.0.0.1`, `192.168.*.*`, `10.*.*.*`, `172.*.*.*` . + * Additionally, there are limitations on development domains. The editor can be used in the following domains: `localhost`, `*.test`, `*.localhost`, `*.local`, and IP addresses: `127.0.0.1`, `192.168.*.*`, `10.*.*.*`, `172.*.*.*`. * The editor will show a banner informing it was launched for development purposes. * **Intended use**: Designed for development environments such as local work, continuous integration (CI), and end-to-end (E2E) tests. * **Usage limitation**: Must not be used for production environments. * **Editor loads**: Does not consume editor loads. -[Contact us](https://ckeditor.com/contact/?sales=true#contact-form) for more details - ### Production license key This key grants access to your subscription features without imposing any limitations. It **consumes editor loads** (after the 14 days trial period ends). @@ -135,7 +131,7 @@ This key grants access to your subscription features without imposing any limita * **Functionality**: The editor functions without any restrictions. * **Intended use**: Meant for production environments where the software is actively used by end-users. * **Usage limitation**: None specified. -* **Editor loads**: Consumes editor loads, especially after the 14-day trial period ends. +* **Editor loads**: Consumes editor loads. ### Evaluation license key @@ -155,11 +151,12 @@ You need to add the license key to your CKEditor 5 configuration. It is eno ```js ClassicEditor .create( document.querySelector( '#editor' ), { + // Provide the licence key. + licenseKey: '', // Or 'GPL'. + // Load the plugins. plugins: [ /* ... */ ], - // Provide the licence key. - licenseKey: '', // Or 'GPL'. // Display the feature UI element in the toolbar. toolbar: [ /* ... */ ], @@ -171,3 +168,13 @@ ClassicEditor To use premium features, you need to add the relevant plugins to your CKEditor 5. You can use the [CKEditor 5 Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs) to generate a CKEditor 5 preset with the plugins enabled. Alternatively, refer to the installation sections in the plugin documentation to do it on your own. You can read more about {@link getting-started/setup/configuration installing plugins} and {@link getting-started/setup/toolbar toolbar configuration} in dedicated guides. + +## License key regeneration + +License keys may be regenerated, and you will always be informed when this occurs. Regeneration may happen under the following circumstances: + +* **Upon request**: You can request a license key regeneration. +* **Feature updates**: Keys will be regenerated if new features are added to your subscription, either through a plan upgrade or additions to your current plan. + +Your current license keys will remain functional even after regeneration, ensuring you have sufficient time to migrate to the updated keys without disruption. + diff --git a/docs/getting-started/licensing/usage-based-billing.md b/docs/getting-started/licensing/usage-based-billing.md index c839010ff24..6b41619dab2 100644 --- a/docs/getting-started/licensing/usage-based-billing.md +++ b/docs/getting-started/licensing/usage-based-billing.md @@ -55,7 +55,7 @@ By understanding these scenarios, you can better anticipate and manage your edit ### License check and usage data -When the editor is ready, a license check request is sent to our server, along with non-personalized data that helps us understand editor usage. This information also assists in resolving any potential dispute claims. +When the editor is ready, a license check request is sent to our server, along with non-personalized data that helps us understand editor usage. This information also assists us when we work on support requests. The server’s response confirms whether the license is valid. If invalid, the editor will switch to read-only mode. diff --git a/docs/support/license-and-legal.md b/docs/support/license-and-legal.md index 962e405e8f5..99135cdb159 100644 --- a/docs/support/license-and-legal.md +++ b/docs/support/license-and-legal.md @@ -1,7 +1,4 @@ --- -# Scope: -# * Clarify copyright and license conditions. - category: support meta-title: License and legal | CKEditor 5 Documentation order: 30 From e11bd31dfc74f5dc6654578d39127a9ac0a05feb Mon Sep 17 00:00:00 2001 From: Witek Socha Date: Sun, 17 Nov 2024 15:25:30 +0100 Subject: [PATCH 6/8] Align meta-title casing. --- docs/api/index.md | 2 +- docs/framework/architecture/plugins.md | 2 +- docs/getting-started/index.md | 2 +- docs/getting-started/integrations-cdn/angular.md | 2 +- docs/getting-started/integrations-cdn/dotnet.md | 2 +- docs/getting-started/integrations-cdn/laravel.md | 2 +- docs/getting-started/integrations-cdn/next-js.md | 4 ++-- docs/getting-started/integrations-cdn/quick-start.md | 2 +- docs/getting-started/integrations-cdn/react-default-cdn.md | 2 +- .../getting-started/integrations-cdn/react-multiroot-cdn.md | 2 +- docs/getting-started/integrations-cdn/vuejs-v2.md | 6 +++--- docs/getting-started/integrations-cdn/vuejs-v3.md | 2 +- docs/getting-started/integrations/angular.md | 2 +- docs/getting-started/integrations/css.md | 2 +- docs/getting-started/integrations/dotnet.md | 2 +- .../integrations/drupal-real-time-collaboration.md | 4 ++-- docs/getting-started/integrations/laravel.md | 2 +- docs/getting-started/integrations/next-js.md | 4 ++-- docs/getting-started/integrations/quick-start.md | 2 +- docs/getting-started/integrations/react-default-npm.md | 2 +- docs/getting-started/integrations/react-multiroot-npm.md | 2 +- docs/getting-started/integrations/vuejs-v2.md | 6 +++--- docs/getting-started/integrations/vuejs-v3.md | 2 +- docs/getting-started/licensing/usage-based-billing.md | 2 +- docs/getting-started/setup/configuration.md | 2 +- docs/getting-started/setup/csp.md | 2 +- docs/getting-started/setup/css.md | 2 +- docs/getting-started/setup/editor-lifecycle.md | 2 +- docs/getting-started/setup/editor-types.md | 2 +- docs/getting-started/setup/getting-and-setting-data.md | 2 +- docs/getting-started/setup/loading-cdn-resources.md | 2 +- docs/getting-started/setup/optimizing-build-size.md | 2 +- docs/getting-started/setup/typescript-support.md | 2 +- docs/updating/migration-to-cdn/angular.md | 2 +- docs/updating/migration-to-cdn/react.md | 2 +- docs/updating/migration-to-cdn/testing-suite.md | 2 +- docs/updating/migration-to-cdn/vanilla-js.md | 2 +- docs/updating/migration-to-cdn/vuejs-v3.md | 2 +- docs/updating/nim-migration/custom-plugins.md | 4 ++-- docs/updating/nim-migration/customized-builds.md | 2 +- docs/updating/nim-migration/online-builder.md | 2 +- 41 files changed, 49 insertions(+), 49 deletions(-) diff --git a/docs/api/index.md b/docs/api/index.md index 770da629bb0..8f943117c0d 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -1,6 +1,6 @@ --- category: api-reference -meta-title: CKEditor 5 API | CKEditor 5 documentation +meta-title: CKEditor 5 API | CKEditor 5 Documentation --- # API documentation diff --git a/docs/framework/architecture/plugins.md b/docs/framework/architecture/plugins.md index ec8f847cc96..7247fe78140 100644 --- a/docs/framework/architecture/plugins.md +++ b/docs/framework/architecture/plugins.md @@ -6,7 +6,7 @@ category: framework-architecture menu-title: Plugins in CKEditor 5 -meta-title: Plugins in CKEditor 5 | CKEditor 5 documentation +meta-title: Plugins in CKEditor 5 | CKEditor 5 Documentation toc-limit: 1 order: 10 --- diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index 46d05cc5a4d..6c5fb79a372 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -2,7 +2,7 @@ category: getting-started order: 10 menu-title: Quick Start -meta-title: CKEditor 5 Installation Quick Start | CKEditor 5 documentation +meta-title: CKEditor 5 Installation Quick Start | CKEditor 5 Documentation meta-description: Learn how to start with CKEditor 5, the modern JavaScript-rich text editor. Find installation guides, tutorials, and integration tips. --- diff --git a/docs/getting-started/integrations-cdn/angular.md b/docs/getting-started/integrations-cdn/angular.md index e5c9be56de1..d3dfa43098a 100644 --- a/docs/getting-started/integrations-cdn/angular.md +++ b/docs/getting-started/integrations-cdn/angular.md @@ -1,6 +1,6 @@ --- menu-title: Angular -meta-title: Angular rich text editor component with CDN | CKEditor 5 documentation +meta-title: Angular rich text editor component with CDN | CKEditor 5 Documentation meta-description: Install, integrate, and configure CKEditor 5 using the Angular component with CDN. category: cloud order: 30 diff --git a/docs/getting-started/integrations-cdn/dotnet.md b/docs/getting-started/integrations-cdn/dotnet.md index 1062898d1ee..c0980c3aa43 100644 --- a/docs/getting-started/integrations-cdn/dotnet.md +++ b/docs/getting-started/integrations-cdn/dotnet.md @@ -1,6 +1,6 @@ --- category: cloud -meta-title: Using CKEditor 5 with .NET and CDN | CKEditor 5 documentation +meta-title: Using CKEditor 5 with .NET and CDN | CKEditor 5 Documentation meta-description: Integrate CKEditor 5 with .NET using CDN. order: 80 menu-title: .NET diff --git a/docs/getting-started/integrations-cdn/laravel.md b/docs/getting-started/integrations-cdn/laravel.md index 2f6f24abf63..5087caebfc6 100644 --- a/docs/getting-started/integrations-cdn/laravel.md +++ b/docs/getting-started/integrations-cdn/laravel.md @@ -1,6 +1,6 @@ --- category: cloud -meta-title: Using CKEditor 5 with Laravel and CDN | CKEditor 5 documentation +meta-title: Using CKEditor 5 with Laravel and CDN | CKEditor 5 Documentation meta-description: Integrate CKEditor 5 with Laravel using CDN. order: 70 menu-title: Laravel diff --git a/docs/getting-started/integrations-cdn/next-js.md b/docs/getting-started/integrations-cdn/next-js.md index c61690b114a..4ef8dd4c396 100644 --- a/docs/getting-started/integrations-cdn/next-js.md +++ b/docs/getting-started/integrations-cdn/next-js.md @@ -1,6 +1,6 @@ --- menu-title: Next.js -meta-title: Integration with Next.js using CDN | CKEditor 5 documentation +meta-title: Integration with Next.js using CDN | CKEditor 5 Documentation meta-description: Integrate CKEditor 5 with the Next.js framework using both routing strategies (App Router or Pages Router) and CDN. category: cloud order: 40 @@ -116,4 +116,4 @@ You can run your project now. If you chose `create-next-app`, type `npm run dev` If you have trouble seeing the editor, remember that the Next.js project ships with CSS files that can interfere with the editor. You can remove them or add your styling. -Also, pay attention to the import path – this guide uses the [default import alias](https://nextjs.org/docs/app/building-your-application/configuring/absolute-imports-and-module-aliases) (@). If you did not configure it, change the path \ No newline at end of file +Also, pay attention to the import path – this guide uses the [default import alias](https://nextjs.org/docs/app/building-your-application/configuring/absolute-imports-and-module-aliases) (@). If you did not configure it, change the path diff --git a/docs/getting-started/integrations-cdn/quick-start.md b/docs/getting-started/integrations-cdn/quick-start.md index 3bbf6c2aef5..8c8a4977ae9 100644 --- a/docs/getting-started/integrations-cdn/quick-start.md +++ b/docs/getting-started/integrations-cdn/quick-start.md @@ -1,6 +1,6 @@ --- menu-title: Vanilla JS -meta-title: Vanilla JS CKEditor 5 Installation - Quick Start with CDN | CKEditor 5 documentation +meta-title: Vanilla JS CKEditor 5 Installation - Quick Start with CDN | CKEditor 5 Documentation meta-description: Install, integrate and configure CKEditor 5 using Vanilla JS with CDN. category: cloud order: 20 diff --git a/docs/getting-started/integrations-cdn/react-default-cdn.md b/docs/getting-started/integrations-cdn/react-default-cdn.md index 05ad92108a6..efd3c7455b8 100644 --- a/docs/getting-started/integrations-cdn/react-default-cdn.md +++ b/docs/getting-started/integrations-cdn/react-default-cdn.md @@ -1,6 +1,6 @@ --- menu-title: Default integration -meta-title: React rich text editor component with CDN | CKEditor 5 documentation +meta-title: React rich text editor component with CDN | CKEditor 5 Documentation meta-description: Install, integrate and configure CKEditor 5 using the React component with CDN. category: react-cdn order: 10 diff --git a/docs/getting-started/integrations-cdn/react-multiroot-cdn.md b/docs/getting-started/integrations-cdn/react-multiroot-cdn.md index 36f055ce894..7430a8c4205 100644 --- a/docs/getting-started/integrations-cdn/react-multiroot-cdn.md +++ b/docs/getting-started/integrations-cdn/react-multiroot-cdn.md @@ -1,6 +1,6 @@ --- menu-title: Multi-root integration -meta-title: React rich text editor multi-root hook with CDN | CKEditor 5 documentation +meta-title: React rich text editor multi-root hook with CDN | CKEditor 5 Documentation meta-description: Install, integrate and configure CKEditor 5 using the React multi-root hook with CDN. category: react-cdn order: 20 diff --git a/docs/getting-started/integrations-cdn/vuejs-v2.md b/docs/getting-started/integrations-cdn/vuejs-v2.md index 4da0ace3ef0..40c8eaaa403 100644 --- a/docs/getting-started/integrations-cdn/vuejs-v2.md +++ b/docs/getting-started/integrations-cdn/vuejs-v2.md @@ -1,6 +1,6 @@ --- menu-title: Vue.js 2.x -meta-title: Vue.js 2.x rich text editor component with CDN | CKEditor 5 documentation +meta-title: Vue.js 2.x rich text editor component with CDN | CKEditor 5 Documentation meta-description: Install, integrate and configure CKEditor 5 using the Vue.js 2.x component with CDN. category: cloud order: 40 @@ -45,7 +45,7 @@ Then, include the CKEditor 5 scripts and styles. All necessary scripts and - + @@ -101,7 +101,7 @@ export default { licenseKey: '', plugins: [ Bold, Essentials, Italic, Mention, Paragraph, SlashCommand ], toolbar: [ 'undo', 'redo', '|', 'bold', 'italic' ], - mention: { + mention: { // Mention configuration } } diff --git a/docs/getting-started/integrations-cdn/vuejs-v3.md b/docs/getting-started/integrations-cdn/vuejs-v3.md index f0e75c64c82..17f1d8c5e9f 100644 --- a/docs/getting-started/integrations-cdn/vuejs-v3.md +++ b/docs/getting-started/integrations-cdn/vuejs-v3.md @@ -1,6 +1,6 @@ --- menu-title: Vue.js 3+ -meta-title: Vue.js 3+ rich text editor component with CDN | CKEditor 5 documentation +meta-title: Vue.js 3+ rich text editor component with CDN | CKEditor 5 Documentation meta-description: Install, integrate and configure CKEditor 5 using the Vue.js 3+ component with CDN. category: cloud order: 50 diff --git a/docs/getting-started/integrations/angular.md b/docs/getting-started/integrations/angular.md index db3419dd523..70d45e28e15 100644 --- a/docs/getting-started/integrations/angular.md +++ b/docs/getting-started/integrations/angular.md @@ -1,6 +1,6 @@ --- menu-title: Angular -meta-title: Angular rich text editor component (npm) | CKEditor 5 documentation +meta-title: Angular rich text editor component (npm) | CKEditor 5 Documentation meta-description: Install, integrate and configure CKEditor 5 using the Angular component with npm. category: self-hosted order: 30 diff --git a/docs/getting-started/integrations/css.md b/docs/getting-started/integrations/css.md index dec447322a7..424f0e6649e 100644 --- a/docs/getting-started/integrations/css.md +++ b/docs/getting-started/integrations/css.md @@ -1,6 +1,6 @@ --- menu-title: CSS frameworks -meta-title: Compatibility with CSS frameworks with npm | CKEditor 5 documentation +meta-title: Compatibility with CSS frameworks with npm | CKEditor 5 Documentation meta-description: Install, integrate and configure CKEditor 5 using CSS frameworks category: installation order: 90 diff --git a/docs/getting-started/integrations/dotnet.md b/docs/getting-started/integrations/dotnet.md index ff8704cdddf..e3fbb735a17 100644 --- a/docs/getting-started/integrations/dotnet.md +++ b/docs/getting-started/integrations/dotnet.md @@ -1,6 +1,6 @@ --- category: self-hosted -meta-title: Compatibility with .NET using a ZIP archive | CKEditor 5 documentation +meta-title: Compatibility with .NET using a ZIP archive | CKEditor 5 Documentation meta-description: Integrate CKEditor 5 with .NET using a ZIP archive. order: 80 menu-title: .NET diff --git a/docs/getting-started/integrations/drupal-real-time-collaboration.md b/docs/getting-started/integrations/drupal-real-time-collaboration.md index 3dfc3a6309c..b0d253b4174 100644 --- a/docs/getting-started/integrations/drupal-real-time-collaboration.md +++ b/docs/getting-started/integrations/drupal-real-time-collaboration.md @@ -1,6 +1,6 @@ --- menu-title: Drupal -meta-title: Real-time editing in Drupal | CKEditor 5 documentation +meta-title: Real-time editing in Drupal | CKEditor 5 Documentation meta-description: Learn how to set up real-time collaboration in the Drupal editing platform with the CKEditor 5 Premium Features module. category: installation order: 100 @@ -68,7 +68,7 @@ The [CKEditor 5 Plugin Pack](https://www.drupal.org/project/ckeditor5_plugi * {@link features/word-count Word count} * Free version of {@link features/spelling-and-grammar-checking WProofreader} – limitation of the free version are listed [on this page](https://www.drupal.org/docs/extending-drupal/contributed-modules/contributed-module-documentation/ckeditor-5-plugin-pack/wproofreader-free-vs-premium-feature-comparison) -Plugin Pack also makes it possible to use some of the premium features for free. +Plugin Pack also makes it possible to use some of the premium features for free. Currently available premium features: diff --git a/docs/getting-started/integrations/laravel.md b/docs/getting-started/integrations/laravel.md index cc82fa7952f..f56d798f12c 100644 --- a/docs/getting-started/integrations/laravel.md +++ b/docs/getting-started/integrations/laravel.md @@ -1,6 +1,6 @@ --- category: self-hosted -meta-title: Compatibility with Laravel using a ZIP archive | CKEditor 5 documentation +meta-title: Compatibility with Laravel using a ZIP archive | CKEditor 5 Documentation meta-description: Integrate CKEditor 5 with Laravel using a ZIP archive. order: 70 menu-title: Laravel diff --git a/docs/getting-started/integrations/next-js.md b/docs/getting-started/integrations/next-js.md index 9b16bf4edd8..91a2e1583f4 100644 --- a/docs/getting-started/integrations/next-js.md +++ b/docs/getting-started/integrations/next-js.md @@ -1,6 +1,6 @@ --- menu-title: Next.js -meta-title: Integration with Next.js using npm | CKEditor 5 documentation +meta-title: Integration with Next.js using npm | CKEditor 5 Documentation meta-description: Integrate CKEditor 5 with the Next.js framework using both routing strategies (App Router or Pages Router) and npm. category: self-hosted order: 40 @@ -63,7 +63,7 @@ function CustomEditor() { licenseKey: '', plugins: [ Bold, Essentials, Italic, Mention, Paragraph, SlashCommand, Undo ], toolbar: [ 'undo', 'redo', '|', 'bold', 'italic' ], - mention: { + mention: { // Mention configuration }, initialData: '

Hello from CKEditor 5 in React!

' diff --git a/docs/getting-started/integrations/quick-start.md b/docs/getting-started/integrations/quick-start.md index 50d205191aa..0afcc10c3ea 100644 --- a/docs/getting-started/integrations/quick-start.md +++ b/docs/getting-started/integrations/quick-start.md @@ -1,6 +1,6 @@ --- menu-title: Vanilla JS -meta-title: Vanilla JS CKEditor 5 installation - quick start with npm or ZIP | CKEditor 5 documentation +meta-title: Vanilla JS CKEditor 5 installation - quick start with npm or ZIP | CKEditor 5 Documentation meta-description: Install, integrate and configure CKEditor 5 using npm or ZIP. category: self-hosted order: 20 diff --git a/docs/getting-started/integrations/react-default-npm.md b/docs/getting-started/integrations/react-default-npm.md index 48704c06c4c..871bd837541 100644 --- a/docs/getting-started/integrations/react-default-npm.md +++ b/docs/getting-started/integrations/react-default-npm.md @@ -1,6 +1,6 @@ --- menu-title: Default integration -meta-title: React rich text editor component (npm) | CKEditor 5 documentation +meta-title: React rich text editor component (npm) | CKEditor 5 Documentation meta-description: Install, integrate and configure CKEditor 5 using the default React component with npm. category: react-npm order: 10 diff --git a/docs/getting-started/integrations/react-multiroot-npm.md b/docs/getting-started/integrations/react-multiroot-npm.md index 57204cc7db8..b7b3922b84f 100644 --- a/docs/getting-started/integrations/react-multiroot-npm.md +++ b/docs/getting-started/integrations/react-multiroot-npm.md @@ -1,6 +1,6 @@ --- menu-title: Multi-root integration -meta-title: React rich text editor multi-root hook with npm | CKEditor 5 documentation +meta-title: React rich text editor multi-root hook with npm | CKEditor 5 Documentation meta-description: Install, integrate and configure CKEditor 5 using the React multi-root hook with npm. category: react-npm order: 20 diff --git a/docs/getting-started/integrations/vuejs-v2.md b/docs/getting-started/integrations/vuejs-v2.md index 8c88920095d..f7b806e24c5 100644 --- a/docs/getting-started/integrations/vuejs-v2.md +++ b/docs/getting-started/integrations/vuejs-v2.md @@ -1,6 +1,6 @@ --- menu-title: Vue.js 2.x -meta-title: Vue.js 2.x rich text editor component (npm) | CKEditor 5 documentation +meta-title: Vue.js 2.x rich text editor component (npm) | CKEditor 5 Documentation meta-description: Install, integrate and configure CKEditor 5 using the Vue.js 2.x component with npm. category: self-hosted order: 40 @@ -79,7 +79,7 @@ export default { licenseKey: '', // Or 'GPL'. plugins: [ Bold, Essentials, Italic, Mention, Paragraph, SlashCommand ], toolbar: [ 'undo', 'redo', '|', 'bold', 'italic' ], - mention: { + mention: { // Mention configuration } } @@ -402,4 +402,4 @@ For more information, refer to the {@link getting-started/setup/ui-language "Set ## Contributing and reporting issues -The source code of this component is available on GitHub in [https://github.com/ckeditor/ckeditor5-vue2](https://github.com/ckeditor/ckeditor5-vue2). \ No newline at end of file +The source code of this component is available on GitHub in [https://github.com/ckeditor/ckeditor5-vue2](https://github.com/ckeditor/ckeditor5-vue2). diff --git a/docs/getting-started/integrations/vuejs-v3.md b/docs/getting-started/integrations/vuejs-v3.md index 4c199cc9d03..dc412eaf940 100644 --- a/docs/getting-started/integrations/vuejs-v3.md +++ b/docs/getting-started/integrations/vuejs-v3.md @@ -1,6 +1,6 @@ --- menu-title: Vue.js 3+ -meta-title: Vue.js 3+ rich text editor component (npm) | CKEditor 5 documentation +meta-title: Vue.js 3+ rich text editor component (npm) | CKEditor 5 Documentation meta-description: Install, integrate and configure CKEditor 5 using the Vue.js 3+ component with npm. category: self-hosted order: 50 diff --git a/docs/getting-started/licensing/usage-based-billing.md b/docs/getting-started/licensing/usage-based-billing.md index 6b41619dab2..02f3893c869 100644 --- a/docs/getting-started/licensing/usage-based-billing.md +++ b/docs/getting-started/licensing/usage-based-billing.md @@ -1,7 +1,7 @@ --- category: licensing menu-title: Usage-based billing -meta-title: Usage-based billing | CKEditor 5 documentation +meta-title: Usage-based billing | CKEditor 5 Documentation meta-description: Learn how usage-based billing works in CKEditor 5. order: 20 modified_at: 2024-10-28 diff --git a/docs/getting-started/setup/configuration.md b/docs/getting-started/setup/configuration.md index 40d84e9ae45..9e65b6ffdb3 100644 --- a/docs/getting-started/setup/configuration.md +++ b/docs/getting-started/setup/configuration.md @@ -1,7 +1,7 @@ --- category: setup menu-title: Configuring features -meta-title: Configuring editor features | CKEditor 5 documentation +meta-title: Configuring editor features | CKEditor 5 Documentation meta-description: Learn how to configure CKEditor 5 features. order: 30 modified_at: 2024-06-25 diff --git a/docs/getting-started/setup/csp.md b/docs/getting-started/setup/csp.md index 286268cf082..087555ce840 100644 --- a/docs/getting-started/setup/csp.md +++ b/docs/getting-started/setup/csp.md @@ -1,6 +1,6 @@ --- category: setup -meta-title: Content Security Policy | CKEditor 5 documentation +meta-title: Content Security Policy | CKEditor 5 Documentation meta-description: Learn about the CKEditor 5 Content Security Policy. order: 110 --- diff --git a/docs/getting-started/setup/css.md b/docs/getting-started/setup/css.md index dacc3a58e94..c9c3e63ee20 100644 --- a/docs/getting-started/setup/css.md +++ b/docs/getting-started/setup/css.md @@ -1,7 +1,7 @@ --- category: setup menu-title: Editor and content styles -meta-title: Editor and content styles | CKEditor 5 documentation +meta-title: Editor and content styles | CKEditor 5 Documentation meta-description: Learn how to style the editor and content with CSS. order: 90 modified_at: 2024-06-25 diff --git a/docs/getting-started/setup/editor-lifecycle.md b/docs/getting-started/setup/editor-lifecycle.md index afce400c5d7..1ea5b0436be 100644 --- a/docs/getting-started/setup/editor-lifecycle.md +++ b/docs/getting-started/setup/editor-lifecycle.md @@ -1,6 +1,6 @@ --- category: setup -meta-title: Editor lifecycle | CKEditor 5 documentation +meta-title: Editor lifecycle | CKEditor 5 Documentation meta-description: Handling the editor lifecycle. With examples. order: 20 modified_at: 2024-06-25 diff --git a/docs/getting-started/setup/editor-types.md b/docs/getting-started/setup/editor-types.md index 1dacbd3d135..243bfa07e02 100644 --- a/docs/getting-started/setup/editor-types.md +++ b/docs/getting-started/setup/editor-types.md @@ -1,7 +1,7 @@ --- category: setup menu-title: Editor types -meta-title: Editor types | CKEditor 5 documentation +meta-title: Editor types | CKEditor 5 Documentation meta-description: Learn more about available CKEditor 5 editor types. order: 25 modified_at: 2024-06-25 diff --git a/docs/getting-started/setup/getting-and-setting-data.md b/docs/getting-started/setup/getting-and-setting-data.md index b440dcc16ad..b0b25bf70d3 100644 --- a/docs/getting-started/setup/getting-and-setting-data.md +++ b/docs/getting-started/setup/getting-and-setting-data.md @@ -1,6 +1,6 @@ --- category: setup -meta-title: Getting and setting data | CKEditor 5 documentation +meta-title: Getting and setting data | CKEditor 5 Documentation meta-description: Deep-dive into handling data with CKEditor 5. order: 10 --- diff --git a/docs/getting-started/setup/loading-cdn-resources.md b/docs/getting-started/setup/loading-cdn-resources.md index 9815fa366e3..8e1ee2ad26f 100644 --- a/docs/getting-started/setup/loading-cdn-resources.md +++ b/docs/getting-started/setup/loading-cdn-resources.md @@ -1,6 +1,6 @@ --- category: setup -meta-title: Loading CDN resources | CKEditor 5 documentation +meta-title: Loading CDN resources | CKEditor 5 Documentation meta-description: Learn how to load CKEditor 5 resources from CDN. order: 130 modified_at: 2024-09-10 diff --git a/docs/getting-started/setup/optimizing-build-size.md b/docs/getting-started/setup/optimizing-build-size.md index 3b939ea1367..f433ca158f2 100644 --- a/docs/getting-started/setup/optimizing-build-size.md +++ b/docs/getting-started/setup/optimizing-build-size.md @@ -1,6 +1,6 @@ --- category: setup -meta-title: Optimizing build size | CKEditor 5 documentation +meta-title: Optimizing build size | CKEditor 5 Documentation meta-description: Learn how to optimize your CKEdiotr 5 build. order: 120 modified_at: 2024-06-25 diff --git a/docs/getting-started/setup/typescript-support.md b/docs/getting-started/setup/typescript-support.md index dc0a92bee84..2eca16b1ff5 100644 --- a/docs/getting-started/setup/typescript-support.md +++ b/docs/getting-started/setup/typescript-support.md @@ -1,7 +1,7 @@ --- category: setup menu-title: TypeScript support -meta-title: TypeScript support | CKEditor 5 documentation +meta-title: TypeScript support | CKEditor 5 Documentation meta-description: Handle setup, integrations, and development of CKEditor 5 features with TypeScript. modified_at: 2024-06-25 order: 100 diff --git a/docs/updating/migration-to-cdn/angular.md b/docs/updating/migration-to-cdn/angular.md index 5eb634c5cdd..132613513ab 100644 --- a/docs/updating/migration-to-cdn/angular.md +++ b/docs/updating/migration-to-cdn/angular.md @@ -1,6 +1,6 @@ --- menu-title: Angular -meta-title: Angular CKEditor 5 - migrate integration from npm to CDN | CKEditor 5 documentation +meta-title: Angular CKEditor 5 - migrate integration from npm to CDN | CKEditor 5 Documentation meta-description: Migrate Angular CKEditor 5 integration from npm to CDN in a few simple steps. Learn how to install Angular CKEditor 5 integration in your project using the CDN. category: migrations order: 50 diff --git a/docs/updating/migration-to-cdn/react.md b/docs/updating/migration-to-cdn/react.md index 09a61c9c42f..106b8b94f7f 100644 --- a/docs/updating/migration-to-cdn/react.md +++ b/docs/updating/migration-to-cdn/react.md @@ -1,6 +1,6 @@ --- menu-title: React -meta-title: React CKEditor 5 - migrate integration from npm to CDN | CKEditor 5 documentation +meta-title: React CKEditor 5 - migrate integration from npm to CDN | CKEditor 5 Documentation meta-description: Migrate React CKEditor 5 integration from npm to CDN in a few simple steps. Learn how to install React CKEditor 5 integration in your project using the CDN. category: migrations order: 30 diff --git a/docs/updating/migration-to-cdn/testing-suite.md b/docs/updating/migration-to-cdn/testing-suite.md index ab205436a21..c879b8043f3 100644 --- a/docs/updating/migration-to-cdn/testing-suite.md +++ b/docs/updating/migration-to-cdn/testing-suite.md @@ -1,6 +1,6 @@ --- menu-title: Testing suite -meta-title: Vanilla JS CKEditor 5 - migrate testing suite from npm to CDN | CKEditor 5 documentation +meta-title: Vanilla JS CKEditor 5 - migrate testing suite from npm to CDN | CKEditor 5 Documentation meta-description: Migrate CKEditor 5 testing suite from npm to CDN in a few simple steps. Learn how to install CKEditor 5 testing suite in your project using the CDN. category: migrations order: 20 diff --git a/docs/updating/migration-to-cdn/vanilla-js.md b/docs/updating/migration-to-cdn/vanilla-js.md index 74419d55a66..f7784956cc4 100644 --- a/docs/updating/migration-to-cdn/vanilla-js.md +++ b/docs/updating/migration-to-cdn/vanilla-js.md @@ -1,6 +1,6 @@ --- menu-title: Vanilla JS -meta-title: Vanilla JS CKEditor 5 - migrate from npm to CDN | CKEditor 5 documentation +meta-title: Vanilla JS CKEditor 5 - migrate from npm to CDN | CKEditor 5 Documentation meta-description: Migrate CKEditor 5 from npm to CDN in a few simple steps. Learn how to install CKEditor 5 in your project using the CDN. category: migrations order: 10 diff --git a/docs/updating/migration-to-cdn/vuejs-v3.md b/docs/updating/migration-to-cdn/vuejs-v3.md index 3d87d9a0e52..5380eef19b5 100644 --- a/docs/updating/migration-to-cdn/vuejs-v3.md +++ b/docs/updating/migration-to-cdn/vuejs-v3.md @@ -1,6 +1,6 @@ --- menu-title: Vue 3+ -meta-title: Vue CKEditor 5 - migrate integration from npm to CDN | CKEditor 5 documentation +meta-title: Vue CKEditor 5 - migrate integration from npm to CDN | CKEditor 5 Documentation meta-description: Migrate Vue 3+ CKEditor 5 integration from npm to CDN in a few simple steps. Learn how to install Vue 3+ CKEditor 5 integration in your project using the CDN. category: migrations order: 40 diff --git a/docs/updating/nim-migration/custom-plugins.md b/docs/updating/nim-migration/custom-plugins.md index cab31e7ccfd..ef27b339a2a 100644 --- a/docs/updating/nim-migration/custom-plugins.md +++ b/docs/updating/nim-migration/custom-plugins.md @@ -2,7 +2,7 @@ category: nim-migration order: 60 menu-title: Migrating custom plugins -meta-title: Migrating custom plugins to new installation methods | CKEditor 5 documentation +meta-title: Migrating custom plugins to new installation methods | CKEditor 5 Documentation meta-description: Learn how to upgrade custom plugins to the new installation methods. modified_at: 2024-06-25 --- @@ -44,7 +44,7 @@ The main changes we have introduced in the new package generator are: ### Add missing file extensions in imports -Next, as required by the JavaScript modules (ESM), you must add the missing file extensions to all files in the `src`, `tests`, and `sample` folders during import. +Next, as required by the JavaScript modules (ESM), you must add the missing file extensions to all files in the `src`, `tests`, and `sample` folders during import. ```diff - import { Plugin } from 'ckeditor5/src/core'; diff --git a/docs/updating/nim-migration/customized-builds.md b/docs/updating/nim-migration/customized-builds.md index 1d70c5ad7c8..0a3edc4da03 100644 --- a/docs/updating/nim-migration/customized-builds.md +++ b/docs/updating/nim-migration/customized-builds.md @@ -2,7 +2,7 @@ category: nim-migration order: 40 menu-title: Migrating from customized builds -meta-title: Migrating from customized builds to new installation methods | CKEditor 5 documentation +meta-title: Migrating from customized builds to new installation methods | CKEditor 5 Documentation meta-description: Learn how to upgrade from customized builds to the new installation methods. modified_at: 2024-06-25 --- diff --git a/docs/updating/nim-migration/online-builder.md b/docs/updating/nim-migration/online-builder.md index 5e2a50b2459..9e08456dce4 100644 --- a/docs/updating/nim-migration/online-builder.md +++ b/docs/updating/nim-migration/online-builder.md @@ -2,7 +2,7 @@ category: nim-migration order: 30 menu-title: Migrating from legacy Online Builder -meta-title: Migrating from the legacy Online Builder to new installation methods | CKEditor 5 documentation +meta-title: Migrating from the legacy Online Builder to new installation methods | CKEditor 5 Documentation meta-description: Learn how to upgrade build from the legacy Online Builder to new installation methods. modified_at: 2024-06-25 --- From 7d01148b8a999d1130bf5930e21ccfeb558db339 Mon Sep 17 00:00:00 2001 From: Witek Socha Date: Sun, 17 Nov 2024 16:00:41 +0100 Subject: [PATCH 7/8] Fix Next.js license key. --- docs/getting-started/integrations/next-js.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/integrations/next-js.md b/docs/getting-started/integrations/next-js.md index 91a2e1583f4..c3b65748428 100644 --- a/docs/getting-started/integrations/next-js.md +++ b/docs/getting-started/integrations/next-js.md @@ -60,7 +60,7 @@ function CustomEditor() { ', + licenseKey: '', // Or 'GPL'. plugins: [ Bold, Essentials, Italic, Mention, Paragraph, SlashCommand, Undo ], toolbar: [ 'undo', 'redo', '|', 'bold', 'italic' ], mention: { From c7704771798403778149d97ddc134b7021e596ba Mon Sep 17 00:00:00 2001 From: Witek Socha Date: Sun, 17 Nov 2024 16:05:48 +0100 Subject: [PATCH 8/8] Explicit info about the self-hosted. --- .../integrations-cdn/quick-start.md | 14 +++++----- .../integrations/quick-start.md | 27 ++++++++++++++++--- 2 files changed, 31 insertions(+), 10 deletions(-) diff --git a/docs/getting-started/integrations-cdn/quick-start.md b/docs/getting-started/integrations-cdn/quick-start.md index 8c8a4977ae9..a01f3a20a79 100644 --- a/docs/getting-started/integrations-cdn/quick-start.md +++ b/docs/getting-started/integrations-cdn/quick-start.md @@ -17,7 +17,7 @@ CKEditor 5 is a powerful, rich text editor you can embed in your web applic ## Installing CKEditor 5 from CDN - To use our CDN services, [create a free account](https://portal.ckeditor.com/checkout?plan=free). + To use our Cloud CDN services, [create a free account](https://portal.ckeditor.com/checkout?plan=free). Learn more about {@link getting-started/licensing/license-key-and-activation license key activation}. CDN is an alternative method of running CKEditor 5. You can start using it in just a few steps and with a few tags. @@ -25,7 +25,7 @@ CDN is an alternative method of running CKEditor 5. You can start using it Start by attaching a link to style sheets. They contain all styles for the editor's UI and content. You can also include your styles if you like. Refer to the {@link getting-started/setup/css#styling-the-published-content content styles} guide for more information. ```html - + ``` @@ -80,7 +80,7 @@ A simple HTML page with the CKEditor may look like the one below. CKEditor 5 - Quick start CDN - +
@@ -120,9 +120,9 @@ A simple HTML page with the CKEditor may look like the one below. Just like with open-source features, start by attaching a link to style sheets. They contain all styles for the editor's UI and content. The styles are in two separate style sheets – for open-source and premium plugins. You can also include your styles if you like. Refer to the {@link getting-started/setup/css#styling-the-published-content content styles} guide for more information. ```html - + - + ``` @@ -222,7 +222,7 @@ A simple HTML page with the CKEditor may look like the one below. ``` -### Obtaining a license key +### Obtaining a premium features license key To activate CKEditor 5 premium features, you will need a commercial license. The easiest way to get one is to sign up for the [CKEditor Premium Features 14-day free trial](https://portal.ckeditor.com/checkout?plan=free). @@ -245,7 +245,7 @@ To simplify imports, you can use the feature available in browsers – the [ ``` -Once you have added the import map, you can access the editor and its plugins using the defined specifiers. Now, you can use standard imports from the `ckeditor5` and `ckeditor5-premium-features` packages. Please note that to use premium features, you need to activate them with a proper license key, as mentioned in the [Obtaining a license key](#obtaining-a-license-key) section. +Once you have added the import map, you can access the editor and its plugins using the defined specifiers. Now, you can use standard imports from the `ckeditor5` and `ckeditor5-premium-features` packages. Please note that to use premium features, you need to activate them with a proper license key, as mentioned in the [Obtaining a license key](#obtaining-a-premium-features-license-key) section. You must run your code on a local server to use import maps. Opening the HTML file directly in your browser will trigger security rules. These rules (CORS policy) ensure loading modules from the same source. Therefore, set up a local server, like `nginx`, `caddy`, `http-server`, to serve your files over HTTP or HTTPS. diff --git a/docs/getting-started/integrations/quick-start.md b/docs/getting-started/integrations/quick-start.md index 0afcc10c3ea..cb62117c5e6 100644 --- a/docs/getting-started/integrations/quick-start.md +++ b/docs/getting-started/integrations/quick-start.md @@ -30,6 +30,17 @@ Now, you can import all the modules from the `ckeditor5` package. Additionally, **Importing and registering UI translations is optional for American English.** To use the editor in any other language, use imported translations, as shown in the {@link getting-started/setup/ui-language setup section}. + + Starting from v44, a `licenseKey` property is required to use the editor. + If you use a self-hosted editor from npm: + + * You must either comply with the GPL license or + * Obtain a license for {@link getting-started/licensing/license-key-and-activation self-hosting distribution}. + + You can set up [a free trial](https://portal.ckeditor.com/checkout?plan=free) to test the editor and evaluate the self-hosting. + + + ```js import { ClassicEditor, Essentials, Bold, Italic, Font, Paragraph } from 'ckeditor5'; @@ -64,6 +75,16 @@ That is all the code you need to see a bare-bone editor running in your web brow If you do not want to build your project using npm and cannot rely on the CDN delivery, you can download ready-to-run files with CKEditor 5 and all its plugins. + + Starting from v44, a `licenseKey` property is required to use the editor. + If you use a self-hosted editor from ZIP: + + * You must either comply with the GPL license or + * Obtain a license for {@link getting-started/licensing/license-key-and-activation self-hosting distribution}. + + You can set up [a free trial](https://portal.ckeditor.com/checkout?plan=free) to test the editor and evaluate the self-hosting. + + 1. Download the ZIP archive with the latest CKEditor 5 distribution. 2. Extract the ZIP archive into a dedicated directory inside your project (for example, `vendor/`). Include the editor version in the directory name to ensure proper cache invalidation whenever you install a new version of CKEditor 5. @@ -117,7 +138,7 @@ ClassicEditor .catch( /* ... */ ); ``` -Pass the imported plugins inside the configuration to the {@link module:editor-classic/classiceditor~ClassicEditor#create `create()`} method and add toolbar items where applicable. Please note that to use premium features, you need to activate them with a proper license key. See the [Obtaining a license key](#obtaining-a-license-key) section. +Pass the imported plugins inside the configuration to the {@link module:editor-classic/classiceditor~ClassicEditor#create `create()`} method and add toolbar items where applicable. Please note that to use premium features, you need to activate them with a proper license key. See the [Obtaining a license key](#obtaining-a-premium-features-license-key) section. The first argument in the `create()` function is a DOM element for the editor placement, so you need to add it to your HTML page. @@ -133,7 +154,7 @@ That is all the code you need to see a bare-bone editor running in your web brow 1. Download the ZIP archive with the latest CKEditor 5 distribution and premium features. 2. Extract the ZIP archive into a dedicated directory inside your project (for example, `vendor/`). Include the editor version in the directory name to ensure proper cache invalidation whenever you install a new version of CKEditor 5. -3. [Obtain a license key](#obtaining-a-license-key) and replace it in the editor configuration. +3. [Obtain a license key](#obtaining-a-premium-features-license-key) and replace it in the editor configuration. Files in the ZIP archive: @@ -159,7 +180,7 @@ The easiest way to see the editor in action is to serve the `index.html` file vi You must run your code on a local server to use import maps. Opening the HTML file directly in your browser will trigger security rules. These rules (CORS policy) ensure loading modules from the same source. Therefore, set up a local server, like `nginx`, `caddy`, `http-server`, to serve your files over HTTP or HTTPS. -### Obtaining a license key +### Obtaining a premium features license key To activate CKEditor 5 premium features, you will need a commercial license. The easiest way to get one is to sign up for the [CKEditor Premium Features 14-day free trial](https://portal.ckeditor.com/checkout?plan=free) to test the premium features.