瀏覽代碼

Docs: Package page and README. [skip ci]

Piotrek Koszuliński 8 年之前
父節點
當前提交
c4bc803716
共有 2 個文件被更改,包括 33 次插入1 次删除
  1. 1 1
      packages/ckeditor5-enter/README.md
  2. 32 0
      packages/ckeditor5-enter/docs/api/enter.md

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

@@ -8,7 +8,7 @@ CKEditor 5 enter feature
 [![Dependency Status](https://david-dm.org/ckeditor/ckeditor5-enter/status.svg)](https://david-dm.org/ckeditor/ckeditor5-enter)
 [![devDependency Status](https://david-dm.org/ckeditor/ckeditor5-enter/dev-status.svg)](https://david-dm.org/ckeditor/ckeditor5-enter?type=dev)
 
-The Enter feature for CKEditor 5. More information about the project can be found at the following URL: <https://github.com/ckeditor/ckeditor5-enter>.
+The <kbd>Enter</kbd> support for CKEditor 5. More information about the project can be found at the following URL: <https://github.com/ckeditor/ckeditor5-enter>.
 
 ## License
 

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

@@ -0,0 +1,32 @@
+---
+category: api-reference
+---
+
+# CKEditor 5 enter feature
+
+[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-enter.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-enter)
+
+This package implements the <kbd>Enter</kbd> key support for CKEditor 5.
+
+## Documentation
+
+See the {@link module:enter/enter~Enter} plugin documentation.
+
+This plugin is normally enabled by the {@link module:essentials/essentials~Essentials} plugin from the {@link api/essentials `@ckeditor/ckeditor5-essentials`} package (which also enables other essential editing features).
+
+## Installation
+
+```bash
+npm install --save @ckeditor/ckeditor5-enter
+```
+
+## Contribute
+
+The source code of this package is available on GitHub in https://github.com/ckeditor/ckeditor5-enter.
+
+## External links
+
+* [`@ckeditor/ckeditor5-enter` on npm](https://www.npmjs.com/package/@ckeditor/ckeditor5-enter)
+* [`ckeditor/ckeditor5-enter` on GitHub](https://github.com/ckeditor/ckeditor5-enter)
+* [Issue tracker](https://github.com/ckeditor/ckeditor5-enter/issues)
+* [Changelog](https://github.com/ckeditor/ckeditor5-enter/blob/master/CHANGELOG.md)