From 177b4d3cf9985b5556c6c56c7b4095df477c888f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Smyrek?= Date: Mon, 10 Jul 2023 07:21:52 +0200 Subject: [PATCH 1/3] Docs for Angular guide that requires peer dependencies. --- docs/installation/integrations/angular.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/installation/integrations/angular.md b/docs/installation/integrations/angular.md index 6698d0946ef..df420f61de1 100644 --- a/docs/installation/integrations/angular.md +++ b/docs/installation/integrations/angular.md @@ -97,6 +97,19 @@ npm install --save @ckeditor/ckeditor5-angular If you don't have an existing project, you can use the [Angular CLI](https://angular.io/cli) to create a new one. +The `@ckeditor/ckeditor5-angular` package requires the following peer dependencies, with a version of at least 37.0.0: + +* `@ckeditor/ckeditor5-core`, +* `@ckeditor/ckeditor5-engine`, +* `@ckeditor/ckeditor5-utils`, +* `@ckeditor/ckeditor5-watchdog`. + +Install all the required peer dependencies: + +```bash +npm install --save @ckeditor/ckeditor5-core @ckeditor/ckeditor5-engine @ckeditor/ckeditor5-utils @ckeditor/ckeditor5-watchdog +``` + Install one of the {@link installation/getting-started/predefined-builds CKEditor 5 predefined builds} or [create a custom one](#using-a-custom-ckeditor-5-build). This tutorial assumes that you picked [`@ckeditor/ckeditor5-build-classic`](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-classic): From 706348abb5eedbbcf0cbfc0cb857e18e2ebcd630 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Smyrek?= Date: Mon, 10 Jul 2023 08:40:43 +0200 Subject: [PATCH 2/3] Added note with versions requirement. --- docs/installation/integrations/angular.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/installation/integrations/angular.md b/docs/installation/integrations/angular.md index df420f61de1..aa6718b3d75 100644 --- a/docs/installation/integrations/angular.md +++ b/docs/installation/integrations/angular.md @@ -97,6 +97,14 @@ npm install --save @ckeditor/ckeditor5-angular If you don't have an existing project, you can use the [Angular CLI](https://angular.io/cli) to create a new one. +Install one of the {@link installation/getting-started/predefined-builds CKEditor 5 predefined builds} or [create a custom one](#using-a-custom-ckeditor-5-build). + +This tutorial assumes that you picked [`@ckeditor/ckeditor5-build-classic`](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-classic): + +```bash +npm install --save @ckeditor/ckeditor5-build-classic +``` + The `@ckeditor/ckeditor5-angular` package requires the following peer dependencies, with a version of at least 37.0.0: * `@ckeditor/ckeditor5-core`, @@ -104,20 +112,14 @@ The `@ckeditor/ckeditor5-angular` package requires the following peer dependenci * `@ckeditor/ckeditor5-utils`, * `@ckeditor/ckeditor5-watchdog`. +Keep in mind that they {@link installation/plugins/installing-plugins#requirements must have the same version as the editor build}. + Install all the required peer dependencies: ```bash npm install --save @ckeditor/ckeditor5-core @ckeditor/ckeditor5-engine @ckeditor/ckeditor5-utils @ckeditor/ckeditor5-watchdog ``` -Install one of the {@link installation/getting-started/predefined-builds CKEditor 5 predefined builds} or [create a custom one](#using-a-custom-ckeditor-5-build). - -This tutorial assumes that you picked [`@ckeditor/ckeditor5-build-classic`](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-classic): - -```bash -npm install --save @ckeditor/ckeditor5-build-classic -``` - Now, add `CKEditorModule` to modules whose components will be using the `` component in their templates. ```ts From 4f6ced7fa374b9831912da5b670bb162e8384797 Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Mon, 10 Jul 2023 13:16:23 +0200 Subject: [PATCH 3/3] Make package names clickable. --- docs/installation/integrations/angular.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/installation/integrations/angular.md b/docs/installation/integrations/angular.md index aa6718b3d75..fe403fdaac9 100644 --- a/docs/installation/integrations/angular.md +++ b/docs/installation/integrations/angular.md @@ -105,12 +105,12 @@ This tutorial assumes that you picked [`@ckeditor/ckeditor5-build-classic`](http npm install --save @ckeditor/ckeditor5-build-classic ``` -The `@ckeditor/ckeditor5-angular` package requires the following peer dependencies, with a version of at least 37.0.0: +The [`@ckeditor/ckeditor5-angular`](https://www.npmjs.com/package/@ckeditor/ckeditor5-angular) package requires the following peer dependencies, with a version of at least 37.0.0: -* `@ckeditor/ckeditor5-core`, -* `@ckeditor/ckeditor5-engine`, -* `@ckeditor/ckeditor5-utils`, -* `@ckeditor/ckeditor5-watchdog`. +* [`@ckeditor/ckeditor5-core`](https://www.npmjs.com/package/@ckeditor/ckeditor5-core), +* [`@ckeditor/ckeditor5-engine`](https://www.npmjs.com/package/@ckeditor/ckeditor5-engine), +* [`@ckeditor/ckeditor5-utils`](https://www.npmjs.com/package/@ckeditor/ckeditor5-utils), +* [`@ckeditor/ckeditor5-watchdog`](https://www.npmjs.com/package/@ckeditor/ckeditor5-watchdog). Keep in mind that they {@link installation/plugins/installing-plugins#requirements must have the same version as the editor build}.