Browse Source

Docs: Added package guide. [skip ci]

Piotrek Koszuliński 8 years ago
parent
commit
07d2083be5
1 changed files with 35 additions and 0 deletions
  1. 35 0
      packages/ckeditor5-basic-styles/docs/api/basic-styles.md

+ 35 - 0
packages/ckeditor5-basic-styles/docs/api/basic-styles.md

@@ -0,0 +1,35 @@
+---
+category: api-reference
+---
+
+# CKEditor 5 basic styles feature
+
+[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-basic-styles.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-basic-styles)
+
+This package contains features allowing to apply basic text formatting – bold, italic, underline and code.
+
+## Documentation
+
+Check out the following plugins:
+
+* {@link module:basic-styles/bold~Bold}
+* {@link module:basic-styles/italic~Italic}
+* {@link module:basic-styles/underline~Underline}
+* {@link module:basic-styles/code~Code}
+
+## Installation
+
+```bash
+npm install --save @ckeditor/ckeditor5-basic-styles
+```
+
+## Contribute
+
+The source code of this package is available on GitHub in https://github.com/ckeditor/ckeditor5-basic-styles.
+
+## External links
+
+* [`@ckeditor/ckeditor5-basic-styles` on npm](https://www.npmjs.com/package/@ckeditor/ckeditor5-basic-styles)
+* [`ckeditor/ckeditor5-basic-styles` on GitHub](https://github.com/ckeditor/ckeditor5-basic-styles)
+* [Issue tracker](https://github.com/ckeditor/ckeditor5-basic-styles/issues)
+* [Changelog](https://github.com/ckeditor/ckeditor5-basic-styles/blob/master/CHANGELOG.md)