Sfoglia il codice sorgente

Docs: Added package guide. [skip ci]

Piotrek Koszuliński 8 anni fa
parent
commit
590f211555

+ 30 - 0
packages/ckeditor5-adapter-ckfinder/docs/api/adapter-ckfinder.md

@@ -0,0 +1,30 @@
+---
+category: api-reference
+---
+
+# CKFinder adapter for CKEditor 5
+
+[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-adapter-ckfinder.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-adapter-ckfinder)
+
+This package implements an upload adapter to [CKFinder](https://cksource.com/ckfinder)'s backend.
+
+## Documentation
+
+See the {@link module:adapter-ckfinder/uploadadapter~CKFinderUploadAdapter} plugin documentation and the {@link features/image#Image-upload Image upload} section in the {@link features/image Image feature} guide.
+
+## Installation
+
+```bash
+npm install --save @ckeditor/ckeditor5-adapter-ckfinder
+```
+
+## Contribute
+
+The source code of this package is available on GitHub in https://github.com/ckeditor/ckeditor5-adapter-ckfinder.
+
+## External links
+
+* [`@ckeditor/ckeditor5-adapter-ckfinder` on npm](https://www.npmjs.com/package/@ckeditor/ckeditor5-adapter-ckfinder)
+* [`ckeditor/ckeditor5-adapter-ckfinder` on GitHub](https://github.com/ckeditor/ckeditor5-adapter-ckfinder)
+* [Issue tracker](https://github.com/ckeditor/ckeditor5-adapter-ckfinder/issues)
+* [Changelog](https://github.com/ckeditor/ckeditor5-adapter-ckfinder/blob/master/CHANGELOG.md)