Przeglądaj źródła

Docs: Add docs/api/word-count.md page to documentation.

Mateusz Samsel 6 lat temu
rodzic
commit
6ad512ba77

+ 34 - 0
packages/ckeditor5-word-count/docs/api/word-count.md

@@ -0,0 +1,34 @@
+---
+category: api-reference
+---
+
+# Word count feature for CKEditor 5
+
+[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-word-count.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-word-count)
+
+This package implements the word count feature for CKEditor 5. You can use it to obtain amount of words and/or characters from the editor.
+
+## Demo
+
+Check out the {@link features/word-count#demo demo in the Word count feature} guide.
+
+## Documentation
+
+See the {@link features/word-count Word count feature} guide and the {@link module:word-count/wordcount~WordCount} plugin documentation.
+
+## Installation
+
+```bash
+npm install --save @ckeditor/ckeditor5-word-count
+```
+
+## Contribute
+
+The source code of this package is available on GitHub in https://github.com/ckeditor/ckeditor5-word-count.
+
+## External links
+
+* [`@ckeditor/ckeditor5-word-count` on npm](https://www.npmjs.com/package/@ckeditor/ckeditor5-word-count)
+* [`ckeditor/ckeditor5-word-count` on GitHub](https://github.com/ckeditor/ckeditor5-word-count)
+* [Issue tracker](https://github.com/ckeditor/ckeditor5-word-count/issues)
+* [Changelog](https://github.com/ckeditor/ckeditor5-word-count/blob/master/CHANGELOG.md)