浏览代码

Docs: Package page and README. [skip ci]

Piotrek Koszuliński 8 年之前
父节点
当前提交
e563b30fa5
共有 1 个文件被更改,包括 35 次插入0 次删除
  1. 35 0
      packages/ckeditor5-image/docs/api/image.md

+ 35 - 0
packages/ckeditor5-image/docs/api/image.md

@@ -0,0 +1,35 @@
+---
+category: api-reference
+---
+
+# CKEditor 5 image feature
+
+[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-image.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-image)
+
+This package implements the image feature. The feature is introduced in a grannular form implemented by a couple of plugins.
+
+## Documentation
+
+See the {@link features/image Image feature} guide and the following plugins documentation:
+
+* {@link module:image/image~Image}
+* {@link module:image/imagetoolbar~ImageToolbar}
+* {@link module:image/imagecaption~ImageCaption}
+* {@link module:image/imagestyle~ImageStyle}
+
+## Installation
+
+```bash
+npm install --save @ckeditor/ckeditor5-image
+```
+
+## Contribute
+
+The source code of this package is available on GitHub in https://github.com/ckeditor/ckeditor5-image.
+
+## External links
+
+* [`@ckeditor/ckeditor5-image` on npm](https://www.npmjs.com/package/@ckeditor/ckeditor5-image)
+* [`ckeditor/ckeditor5-image` on GitHub](https://github.com/ckeditor/ckeditor5-image)
+* [Issue tracker](https://github.com/ckeditor/ckeditor5-image/issues)
+* [Changelog](https://github.com/ckeditor/ckeditor5-image/blob/master/CHANGELOG.md)