Parcourir la source

Docs: Horizontal line guide and API page corrected. [skip ci]

Anna Tomanek il y a 6 ans
Parent
commit
1cf535e122

+ 1 - 1
packages/ckeditor5-horizontal-line/docs/api/horizontal-line.md

@@ -18,7 +18,7 @@ See the {@link features/horizontal-line Horizontal line feature} guide and the {
 
 ## Installation
 
-```bash
+```plaintext
 npm install --save @ckeditor/ckeditor5-horizontal-line
 ```
 

+ 10 - 4
packages/ckeditor5-horizontal-line/docs/features/horizontal-line.md

@@ -5,7 +5,7 @@ menu-title: Horizontal line
 
 # Horizontal line
 
-The {@link module:horizontal-line/horizontalline~HorizontalLine} plugin provides a possibility to insert a horizontal line in the rich-text editor.
+The {@link module:horizontal-line/horizontalline~HorizontalLine} plugin provides the possibility to insert a horizontal line into the rich-text editor.
 
 ## Demo
 
@@ -17,7 +17,7 @@ Use the editor below to see the {@link module:horizontal-line/horizontalline~Hor
 
 To add this feature to your rich-text editor, install the [`@ckeditor/ckeditor5-horizontal-line`](https://www.npmjs.com/package/@ckeditor/ckeditor5-horizontal-line) package:
 
-```bash
+```plaintext
 npm install --save @ckeditor/ckeditor5-horizontal-line
 ```
 
@@ -41,15 +41,21 @@ ClassicEditor
 
 ## Common API
 
-The {@link module:horizontal-line/horizontalline~HorizontalLine} plugin registers the UI button component (`'horizontalLine'`) and the `'horizontalLine'` command implemented by {@link module:horizontal-line/horizontallinecommand~HorizontalLineCommand}. 
+The {@link module:horizontal-line/horizontalline~HorizontalLine} plugin registers:
+* the UI button component (`'horizontalLine'`),
+* the `'horizontalLine'` command implemented by {@link module:horizontal-line/horizontallinecommand~HorizontalLineCommand}. 
 
 The command can be executed using the {@link module:core/editor/editor~Editor#execute `editor.execute()`} method:
 
 ```js
-// Inserts the horizontal line to the selected content.
+// Inserts a horizontal line into the selected content.
 editor.execute( 'horizontalLine' );
 ```
 
+<info-box>
+	We recommend using the official {@link framework/guides/development-tools#ckeditor-5-inspector CKEditor 5 inspector} for development and debugging. It will give you tons of useful information about the state of the editor such as internal data structures, selection, commands, and many more.
+</info-box>
+
 ## Contribute
 
 The source code of the feature is available on GitHub in https://github.com/ckeditor/ckeditor5-horizontal-line.