浏览代码

Docs: Added package guide. [skip ci]

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

+ 30 - 0
packages/ckeditor5-autoformat/docs/api/autoformat.md

@@ -0,0 +1,30 @@
+---
+category: api-reference
+---
+
+# CKEditor 5 autoformat feature
+
+[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-autoformat.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-autoformat)
+
+This package implements autoformatting feature – it allows styling text by typing sequences like `**bold this**`.
+
+## Documentation
+
+See the {@link features/autoformat Autoformat feature} guide and {@link module:autoformat/autoformat~Autoformat} plugin documentation.
+
+## Installation
+
+```bash
+npm install --save @ckeditor/ckeditor5-autoformat
+```
+
+## Contribute
+
+The source code of this package is available on GitHub in https://github.com/ckeditor/ckeditor5-autoformat.
+
+## External links
+
+* [`@ckeditor/ckeditor5-autoformat` on npm](https://www.npmjs.com/package/@ckeditor/ckeditor5-autoformat)
+* [`ckeditor/ckeditor5-autoformat` on GitHub](https://github.com/ckeditor/ckeditor5-autoformat)
+* [Issue tracker](https://github.com/ckeditor/ckeditor5-autoformat/issues)
+* [Changelog](https://github.com/ckeditor/ckeditor5-autoformat/blob/master/CHANGELOG.md)