8
0
Maciej Gołaszewski 8 лет назад
Родитель
Сommit
462d6a9244
2 измененных файлов с 33 добавлено и 0 удалено
  1. 31 0
      packages/ckeditor5-font/docs/api/font.md
  2. 2 0
      packages/ckeditor5-font/src/font.js

+ 31 - 0
packages/ckeditor5-font/docs/api/font.md

@@ -0,0 +1,31 @@
+---
+category: api-reference
+---
+
+# CKEditor 5 font feature
+
+[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-font.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-font)
+
+This package implements the font family and font size features for CKEditor 5.
+
+## Documentation
+
+See the {@link features/font-family Font family feature} and {@link features/font-size Font size feature} guides 
+with corresponding {@link module:font/fontfamily~FontFamily} and {@link module:font/fontsize~FontSize} plugin documentation.
+
+## Installation
+
+```bash
+npm install --save @ckeditor/ckeditor5-font
+```
+
+## Contribute
+
+The source code of this package is available on GitHub in https://github.com/ckeditor/ckeditor5-font.
+
+## External links
+
+* [`@ckeditor/ckeditor5-font` on npm](https://www.npmjs.com/package/@ckeditor/ckeditor5-font)
+* [`ckeditor/ckeditor5-font` on GitHub](https://github.com/ckeditor/ckeditor5-font)
+* [Issue tracker](https://github.com/ckeditor/ckeditor5-font/issues)
+* [Changelog](https://github.com/ckeditor/ckeditor5-font/blob/master/CHANGELOG.md)

+ 2 - 0
packages/ckeditor5-font/src/font.js

@@ -17,6 +17,8 @@ import FontSize from './fontsize';
  *
  * It requires {@link module:font/fontsize~FontSize} and {@link module:font/fontfamily~FontFamily} plugins.
  *
+ * Read more about the feature in the {@glink api/font font package} page.
+ *
  * @extends module:core/plugin~Plugin
  */
 export default class Font extends Plugin {