8
0
Просмотр исходного кода

Docs: fixed invalid @link and added note to default color format.

Damian Konopka 7 лет назад
Родитель
Сommit
5f9be18da8
1 измененных файлов с 5 добавлено и 4 удалено
  1. 5 4
      packages/ckeditor5-highlight/src/highlight.js

+ 5 - 4
packages/ckeditor5-highlight/src/highlight.js

@@ -53,8 +53,8 @@ export default class Highlight extends Plugin {
  * @property {String} title The user-readable title of the option.
  * @property {String} model The unique attribute value in the model.
  * @property {String} color The CSS var() used for the highlighter. The color is used in the user interface to represent the highlighter.
- * It is possible to use default color format.
- * See: {@link features/highlight#inline Custom colors - Inline}.
+ * There is possibility to use default color format like rgb, hex or hsl, but you need to care about color of `<mark>`
+ * by adding CSS classes definition.
  * @property {String} class The CSS class used on the `<mark>` element in the view. It should match the `color` setting.
  * @property {'marker'|'pen'} type The type of highlighter:
  * - `'marker'` – uses the `color` as a `background-color` style,
@@ -137,8 +137,9 @@ export default class Highlight extends Plugin {
  * - `'pen'` - rendered as a `<mark>` element, styled with the font `color`.
  *
  * **Note**: A stylesheet with CSS classes is required for the configuration to work properly thanks to CSS Variables.
- * The highlight feature provides actual stylesheet with default colors. It is possible to use inline color format
- * like rgb/hex or hsl. See: {@link features/highlight#inline Custom colors - Inline}.
+ * The highlight feature provides actual stylesheet with default colors. There is possibility to use default color format
+ * like rgb, hex or hsl. In this situation colors apply only to the icons of marker and pen. You need to care about
+ * color or background of `<mark>` by adding CSS classes definition.
  *
  * **Note**: It is recommended that the `color` value should correspond to the class in the content
  * style sheet. It represents the highlighter in the user interface of the editor.