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

Docs: Small changes in documentation. [skip ci]

Wiktor Walc 8 лет назад
Родитель
Сommit
be07ebf03e

+ 1 - 1
packages/ckeditor5-heading/docs/_snippets/features/custom-heading-levels.html

@@ -1,5 +1,5 @@
 <div id="snippet-custom-heading-levels">
 <div id="snippet-custom-heading-levels">
 	<h1>Heading 1</h1>
 	<h1>Heading 1</h1>
 	<h2>Heading 2</h2>
 	<h2>Heading 2</h2>
-	<p>This is <a href="https://ckeditor5.github.io">CKEditor&nbsp;5</a>.</p>
+	<p>This is <a href="https://ckeditor5.github.io">CKEditor 5</a>.</p>
 </div>
 </div>

+ 7 - 7
packages/ckeditor5-heading/docs/features/headings.md

@@ -8,7 +8,7 @@ category: features
 The {@link module:heading/heading~Heading} feature enables support for headings.
 The {@link module:heading/heading~Heading} feature enables support for headings.
 
 
 <info-box info>
 <info-box info>
-	This feature is enabled by default in all builds. It is also included in the {@link module:presets/article~Article Article preset}.
+	This feature is enabled by default in all builds.
 </info-box>
 </info-box>
 
 
 ## Heading levels
 ## Heading levels
@@ -23,14 +23,14 @@ By default this feature is configured to support `<h2>`, `<h3>` and `<h4>` eleme
 
 
 It is, of course, possible to configure which heading levels the editor should support and how they should be named in the Headings dropdown. Use the {@link module:heading/heading~HeadingConfig#options `heading.options`} configuration option to do so.
 It is, of course, possible to configure which heading levels the editor should support and how they should be named in the Headings dropdown. Use the {@link module:heading/heading~HeadingConfig#options `heading.options`} configuration option to do so.
 
 
-The following editor will support only two levels of headings &mdash; `<h1>` and `<h2>`:
+For example, the following editor will support only two levels of headings &mdash; `<h1>` and `<h2>`:
 
 
 
 
 ```html
 ```html
 <div id="editor">
 <div id="editor">
 	<h1>Heading 1</h1>
 	<h1>Heading 1</h1>
 	<h2>Heading 2</h2>
 	<h2>Heading 2</h2>
-	<p>This is <a href="https://ckeditor5.github.io">CKEditor&nbsp;5</a>.</p>
+	<p>This is <a href="https://ckeditor5.github.io">CKEditor 5</a>.</p>
 </div>
 </div>
 ```
 ```
 
 
@@ -51,10 +51,12 @@ ClassicEditor
 
 
 {@snippet features/custom-heading-levels}
 {@snippet features/custom-heading-levels}
 
 
-Read more about the `heading.options` format in {@link module:heading/heading~HeadingConfig#options the API documentation}.
-
 ## Installation
 ## Installation
 
 
+<info-box info>
+	This feature is enabled by default in all builds. The installation instructions are for developers interested in building their own, custom editor.
+</info-box>
+
 To add this feature to your editor install the [`@ckeditor/ckeditor5-heading`](https://www.npmjs.com/package/@ckeditor/ckeditor5-heading) package:
 To add this feature to your editor install the [`@ckeditor/ckeditor5-heading`](https://www.npmjs.com/package/@ckeditor/ckeditor5-heading) package:
 
 
 ```
 ```
@@ -75,8 +77,6 @@ ClassicEditor
 	.catch( ... );
 	.catch( ... );
 ```
 ```
 
 
-If you are using an editor build, see how to {@linkTODO customize builds}.
-
 ## Common API
 ## Common API
 
 
 The {@link module:heading/heading~Heading} plugin registers:
 The {@link module:heading/heading~Heading} plugin registers:

+ 2 - 1
packages/ckeditor5-heading/src/heading.js

@@ -19,7 +19,8 @@ import '../theme/theme.scss';
 
 
 /**
 /**
  * The headings feature. It introduces the `headings` drop-down list and the `heading` command which allow
  * The headings feature. It introduces the `headings` drop-down list and the `heading` command which allow
- * to convert paragraphs into headings.
+ * to convert paragraphs into headings. For a detailed overview, check the
+ * {@glink features/headings Headings feature documentation}.
  *
  *
  * @extends module:core/plugin~Plugin
  * @extends module:core/plugin~Plugin
  */
  */