Bladeren bron

Docs: Package page and README. [skip ci]

Piotrek Koszuliński 8 jaren geleden
bovenliggende
commit
29d90fae71
1 gewijzigde bestanden met toevoegingen van 32 en 0 verwijderingen
  1. 32 0
      packages/ckeditor5-typing/docs/api/typing.md

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

@@ -0,0 +1,32 @@
+---
+category: api-reference
+---
+
+# CKEditor 5 typing feature
+
+[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-typing.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-typing)
+
+This package implements support for typing (inputting and deleting text) in CKEditor 5.
+
+## Documentation
+
+See the {@link module:typing/typing~Typing} 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-typing
+```
+
+## Contribute
+
+The source code of this package is available on GitHub in https://github.com/ckeditor/ckeditor5-typing.
+
+## External links
+
+* [`@ckeditor/ckeditor5-typing` on npm](https://www.npmjs.com/package/@ckeditor/ckeditor5-typing)
+* [`ckeditor/ckeditor5-typing` on GitHub](https://github.com/ckeditor/ckeditor5-typing)
+* [Issue tracker](https://github.com/ckeditor/ckeditor5-typing/issues)
+* [Changelog](https://github.com/ckeditor/ckeditor5-typing/blob/master/CHANGELOG.md)