Parcourir la source

Docs: Added package guide. [skip ci]

Piotrek Koszuliński il y a 8 ans
Parent
commit
c2dfd740e2
1 fichiers modifiés avec 32 ajouts et 0 suppressions
  1. 32 0
      packages/ckeditor5-editor-inline/docs/api/editor-inline.md

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

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