Browse Source

Docs: Added package guide. [skip ci]

Piotrek Koszuliński 8 years ago
parent
commit
4c9f3dc774
1 changed files with 32 additions and 0 deletions
  1. 32 0
      packages/ckeditor5-clipboard/docs/api/clipboard.md

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

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