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

Commit

Permalink
Merge pull request #23 from ckeditor/t/image-upload-docs
Browse files Browse the repository at this point in the history
Docs: Add image upload category.
  • Loading branch information
jodator committed Dec 10, 2018
2 parents f5a90f9 + bc32b87 commit 91b2e15
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 6 deletions.
35 changes: 31 additions & 4 deletions docs/features/easy-image.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
category: features
category: features-image-upload
menu-title: Easy Image
order: 20
---

# Easy Image integration

CKEditor 5 introduces a new way of handling images, with a strong focus on the end–user experience. This feature is called {@link features/easy-image Easy Image} and its goal is to make the image upload as effortless and intuitive as possible.
CKEditor 5 introduces a new way of handling images, with a strong focus on the end–user experience. This feature is called [Easy Image](https://ckeditor.com/ckeditor-cloud-services/easy-image/) and its goal is to make the image upload as effortless and intuitive as possible.

<info-box info>
This feature is enabled by default in all builds.
Expand All @@ -20,7 +21,7 @@ Easy Image is part of the [CKEditor Cloud Services](https://ckeditor.com/ckedito
All that with virtually zero server setup.

<info-box>
Check out the comprehensive {@link features/image-upload Image upload guide} to learn about other ways to upload images in CKEditor 5.
Check out the comprehensive {@link features/image-upload Image upload overview} to learn about other ways to upload images in CKEditor 5.
</info-box>

### Demo
Expand Down Expand Up @@ -96,7 +97,33 @@ The variety of the image sizes in the `srcset` attribute allows the web browser

## What's next?

Check out the {@link features/image-upload comprehensive "Image upload" guide} to learn more about different ways of uploading images in CKEditor 5.
Check out the comprehensive {@link features/image-upload Image upload overview} to learn more about different ways of uploading images in CKEditor 5.

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
Original file line number Diff line number Diff line change
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 91b2e15

Please sign in to comment.