Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Commit

Permalink
Merge 49fe419 into f5a90f9
Browse files Browse the repository at this point in the history
  • Loading branch information
jodator committed Dec 10, 2018
2 parents f5a90f9 + 49fe419 commit 3d5bd3a
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 3 deletions.
29 changes: 28 additions & 1 deletion docs/features/easy-image.md
@@ -1,6 +1,7 @@
---
category: features
category: features-image-upload
menu-title: Easy Image
order: 20
---

# Easy Image integration
Expand Down Expand Up @@ -100,3 +101,29 @@ Check out the {@link features/image-upload comprehensive "Image upload" guide} t

See the {@link features/image Image feature} guide to find out more about handling images in CKEditor 5.

## Installation

<info-box info>
This feature is enabled by default in all builds. The installation instructions are for developers interested in building their own, custom WYSIWYG editor.
</info-box>

To add this feature to your editor, install the [`@ckeditor/ckeditor5-easy-image`](https://www.npmjs.com/package/@ckeditor/ckeditor5-easy-image) package:

```bash
npm install --save @ckeditor/ckeditor5-easy-image
```

Then add {@link module:easy-image/easyimage~EasyImage} to your plugin list and [configure](#configuration) the feature. For instance:

```js
import EasyImage from '@ckeditor/ckeditor5-easy-image/src/easyimage';

ClassicEditor
.create( document.querySelector( '#editor' ), {
plugins: [ EasyImage, ... ],
toolbar: [ 'imageUpload' ... ], // Depending on your preference.
cloudServices: // feature configuration
} )
.then( ... )
.catch( ... );
```
4 changes: 2 additions & 2 deletions src/easyimage.js
Expand Up @@ -23,10 +23,10 @@ import ImageUpload from '@ckeditor/ckeditor5-image/src/imageupload';
* * {@link module:image/imageupload~ImageUpload},
* * {@link module:easy-image/cloudservicesuploadadapter~CloudServicesUploadAdapter}.
*
* See the {@glink features/easy-image "Easy Image integration" guide} to learn how to configure
* See the {@glink features/image-upload/easy-image "Easy Image integration" guide} to learn how to configure
* and use this feature.
*
* Check out the {@glink features/image-upload comprehensive "Image upload" guide} to learn about
* Check out the {@glink features/image-upload/image-upload comprehensive "Image upload" guide} to learn about
* other ways to upload images into CKEditor 5.
*
* **Note**: After enabling the Easy Image plugin you need to configure the
Expand Down

0 comments on commit 3d5bd3a

Please sign in to comment.