瀏覽代碼

Docs: Improved links between API and guides. See ckeditor/ckeditor5#1090.

Piotrek Koszuliński 7 年之前
父節點
當前提交
11282adcba

+ 5 - 4
packages/ckeditor5-highlight/docs/features/highlight.md

@@ -1,8 +1,9 @@
 ---
-title: Highlight
 category: features
 ---
 
+# Highlight
+
 {@snippet features/build-highlight-source}
 
 The {@link module:highlight/highlight~Highlight} feature offers text marking tools that help content authors speed up their work, for example when reviewing content or marking it for future reference. It uses inline `<mark>` elements in the view, supports both markers (background color) and pens (text color), and comes with a flexible configuration.
@@ -53,7 +54,7 @@ ClassicEditor
 
 ### Inline buttons
 
-Instead of using the (default) `highlight` button, the feature also supports a configuration with separate buttons available directly in the toolbar:
+Instead of using the (default) `'highlight'` button, the feature also supports a configuration with separate buttons available directly in the toolbar:
 
 ```js
 ClassicEditor
@@ -210,7 +211,7 @@ The {@link module:highlight/highlight~Highlight} plugin registers:
 	]
 	```
 
-	the `highlight` command will accept the corresponding strings as values:
+	the `'highlight'` command will accept the corresponding strings as values:
 
 	* `'yellowMarker'` &ndash; available as the `'highlight:yellowMarker'` button,
 	* `'greenMarker'` &ndash; available as the `'highlight:greenMarker'` button,
@@ -219,7 +220,7 @@ The {@link module:highlight/highlight~Highlight} plugin registers:
 	* `'redPen'` &ndash; available as the `'highlight:redPen'` button,
 	* `'greenPen'` &ndash; available as the `'highlight:greenPen'` button.
 
-	Passing an empty `value` will remove any `highlight` from the selection:
+	Passing an empty `value` will remove any `highlight` attribute from the selection:
 
 	```js
 	editor.execute( 'highlight' );

+ 3 - 3
packages/ckeditor5-highlight/src/highlight.js

@@ -15,10 +15,10 @@ import HighlightUI from './highlightui';
 /**
  * The highlight plugin.
  *
- * It loads the {@link module:highlight/highlightediting~HighlightEditing} and
- * {@link module:highlight/highlightui~HighlightUI} plugins.
+ * For a detailed overview, check the {@glink features/highlight Highlight feature} documentation.
  *
- * For a detailed overview, check the {@glink features/highlight highlight feature} documentation.
+ * This is a "glue" plugin which loads the {@link module:highlight/highlightediting~HighlightEditing} and
+ * {@link module:highlight/highlightui~HighlightUI} plugins.
  *
  * @extends module:core/plugin~Plugin
  */