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

Commit

Permalink
Docs: Updated package docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
oleq committed Mar 12, 2018
1 parent 1259115 commit 4745b7a
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -14,7 +14,7 @@ The decoupled editor implementation for CKEditor 5.

This package contains the [`DecoupledEditor`](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/api/module_editor-decoupled_decouplededitor-DecoupledEditor.html) class. Follow there to learn more about this type of editor and how to initialize it.

This package contains the source version of the decoupled editor. This editor implementation is also available in the [TODO build](https://www.npmjs.com/package/@ckeditor/TODO). Read more about [CKEditor 5 Builds](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/builds/index.html).
This package contains the source version of the decoupled editor. This editor implementation is also available in the [document build](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-decoupled-document). Read more about [CKEditor 5 Builds](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/builds/index.html).

## Documentation

Expand Down
8 changes: 8 additions & 0 deletions docs/framework/guides/document-editor.md
@@ -0,0 +1,8 @@
---
category: framework-ui
order: 30
---

# Document editor

TODO
7 changes: 5 additions & 2 deletions src/decouplededitor.js
Expand Up @@ -22,14 +22,17 @@ import mix from '@ckeditor/ckeditor5-utils/src/mix';
* This type of an editor is dedicated for integrations which require a customized UI with an open
* structure, allowing developers to specify the exact location of the interface.
*
* See the document editor {@glink TODO demo} to learn about possible use cases for the decoupled editor.
* See the document editor {@glink examples/builds/document-editor demo} to learn about possible use cases
* for the decoupled editor.
*
* In order to create a decoupled editor instance, use the static
* {@link module:editor-decoupled/decouplededitor~DecoupledEditor.create `DecoupledEditor.create()`} method.
*
* # Decoupled editor and document build
*
* The decoupled editor can be used directly from source (if you installed the
* [`@ckeditor/ckeditor5-editor-decoupled`](https://www.npmjs.com/package/@ckeditor/ckeditor5-editor-decoupled) package)
* but it is also available in the {@glink builds/guides/overview#TODO TODO}.
* but it is also available in the {@glink builds/guides/overview#document-editor document build}.
*
* {@glink builds/guides/overview Builds} are ready-to-use editors with plugins bundled in. When using the editor from
* source you need to take care of loading all plugins by yourself
Expand Down

0 comments on commit 4745b7a

Please sign in to comment.