浏览代码

Docs: Package page and README. [skip ci]

Piotrek Koszuliński 8 年之前
父节点
当前提交
1d31506227
共有 2 个文件被更改,包括 33 次插入1 次删除
  1. 1 1
      packages/ckeditor5-essentials/README.md
  2. 32 0
      packages/ckeditor5-essentials/docs/api/essentials.md

+ 1 - 1
packages/ckeditor5-essentials/README.md

@@ -12,7 +12,7 @@ Essential editing features for CKEditor 5.
 
 The [`Essentials`](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/api/module_essentials_essentials-Essentials.html) plugin includes all essential editing features:
 
-* [Clipboard](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/api/module_clipboard_clipboard-Clipboard.html)
+* [`Clipboard`](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/api/module_clipboard_clipboard-Clipboard.html)
 * [`Enter`](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/api/module_enter_enter-Enter.html)
 * [`Typing`](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/api/module_typing_typing-Typing.html)
 * [`Undo`](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/api/module_undo_undo-Undo.html)

+ 32 - 0
packages/ckeditor5-essentials/docs/api/essentials.md

@@ -0,0 +1,32 @@
+---
+category: api-reference
+---
+
+# CKEditor 5 essentials plugin
+
+[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-essentials.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-essentials)
+
+Essential editing features for CKEditor 5 wrapped in one plugin.
+
+The {@link module:essentials/essentials~Essentials} plugin exposed by this package enables {@link module:clipboard/clipboard~Clipboard clipboard}, {@link module:enter/enter~Enter enter}, {@link module:typing/typing~Typing typing} and {@link module:undo/undo~Undo undo} support.
+
+## Documentation
+
+See the {@link module:essentials/essentials~Essentials} plugin documentation.
+
+## Installation
+
+```bash
+npm install --save @ckeditor/ckeditor5-essentials
+```
+
+## Contribute
+
+The source code of this package is available on GitHub in https://github.com/ckeditor/ckeditor5-essentials.
+
+## External links
+
+* [`@ckeditor/ckeditor5-essentials` on npm](https://www.npmjs.com/package/@ckeditor/ckeditor5-essentials)
+* [`ckeditor/ckeditor5-essentials` on GitHub](https://github.com/ckeditor/ckeditor5-essentials)
+* [Issue tracker](https://github.com/ckeditor/ckeditor5-essentials/issues)
+* [Changelog](https://github.com/ckeditor/ckeditor5-essentials/blob/master/CHANGELOG.md)