浏览代码

Docs: Improved readme. [skip ci]

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

+ 5 - 1
packages/ckeditor5-autoformat/README.md

@@ -8,7 +8,11 @@ CKEditor 5 autoformat feature
 [![Dependency Status](https://david-dm.org/ckeditor/ckeditor5-autoformat/status.svg)](https://david-dm.org/ckeditor/ckeditor5-autoformat)
 [![devDependency Status](https://david-dm.org/ckeditor/ckeditor5-autoformat/dev-status.svg)](https://david-dm.org/ckeditor/ckeditor5-autoformat?type=dev)
 
-Replaces predefined characters with corresponding structures. More information about the project can be found at the following URL: <https://github.com/ckeditor/ckeditor5-autoformat>.
+This package implements the autoformatting feature for CKEditor 5. It allows styling text by typing sequences like `**bold this**`.
+
+## Documentation
+
+See the [`@ckeditor/ckeditor5-autoformat` package](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/api/autoformat.html) page in [CKEditor 5 documentation](https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/).
 
 ## License
 

+ 1 - 1
packages/ckeditor5-autoformat/docs/api/autoformat.md

@@ -6,7 +6,7 @@ category: api-reference
 
 [![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-autoformat.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-autoformat)
 
-This package implements the autoformatting feature – it allows styling text by typing sequences like `**bold this**`.
+This package implements the autoformatting feature. It allows styling text by typing sequences like `**bold this**`.
 
 ## Documentation