8
0
Просмотр исходного кода

Docs: Added package guide. [skip ci]

Piotrek Koszuliński 8 лет назад
Родитель
Сommit
a343f5b035
1 измененных файлов с 32 добавлено и 0 удалено
  1. 32 0
      packages/ckeditor5-editor-balloon/docs/api/editor-balloon.md

+ 32 - 0
packages/ckeditor5-editor-balloon/docs/api/editor-balloon.md

@@ -0,0 +1,32 @@
+---
+category: api-reference
+---
+
+# CKEditor 5 balloon editor implementation
+
+[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-editor-balloon.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-editor-balloon)
+
+The balloon editor implementation (Medium-like editor). See the {@link examples/builds/balloon-editor demo}.
+
+## Documentation
+
+This package contains the {@link module:editor-balloon/ballooneditor~BalloonEditor} class. Follow there to learn more about this type of editor and how to initialize it.
+
+This package contains the source version of the balloon editor. This editor implementation is also available in the [balloon build](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-balloon). Read more about {@link builds/index CKEditor 5 Builds}.
+
+## Installation
+
+```bash
+npm install --save @ckeditor/ckeditor5-editor-balloon
+```
+
+## Contribute
+
+The source code of this package is available on GitHub in https://github.com/ckeditor/ckeditor5-editor-balloon.
+
+## External links
+
+* [`@ckeditor/ckeditor5-editor-balloon` on npm](https://www.npmjs.com/package/@ckeditor/ckeditor5-editor-balloon)
+* [`ckeditor/ckeditor5-editor-balloon` on GitHub](https://github.com/ckeditor/ckeditor5-editor-balloon)
+* [Issue tracker](https://github.com/ckeditor/ckeditor5-editor-balloon/issues)
+* [Changelog](https://github.com/ckeditor/ckeditor5-editor-balloon/blob/master/CHANGELOG.md)