Browse Source

Docs: Add highlight api page.

Maciej Gołaszewski 7 years ago
parent
commit
2d98452523

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

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

+ 0 - 1
packages/ckeditor5-highlight/src/highlight.js

@@ -110,4 +110,3 @@ export default class Highlight extends Plugin {
  *
  * @member {Array.<module:highlight/highlight~HighlightOption>} module:highlight/highlight~HighlightConfig#options
  */
-