Преглед изворни кода

Docs: restyling the demo; adding feature discoverability. [skip ci]

godai78 пре 5 година
родитељ
комит
c5e9c85496

+ 3 - 3
packages/ckeditor5-heading/docs/_snippets/features/heading-buttons.html

@@ -1,9 +1,9 @@
 <div id="snippet-heading-buttons">
 	<h1>The overall user experience</h1>
-	<h2>Usability</h2>
+	<h3>Usability</h3>
 	<p>There are certain situations, both user-oriented or independent, in which different solutions work better. Splitting the heading dropdown into separate buttons does certainly speed up the access, while at the same time taking up more space. It is up to the user to decide, whether easier accessability prevails over tidy toolbar.</p>
-	<h2>Personal preference</h2>
+	<h3>Personal preference</h3>
 	<p>Usability and editing needs might be one of the factors, but still there is the personal preference - the user's previous experience and habits might come forth and be a decisive factor.</p>
-	<h2>Flexibility</h2>
+	<h3>Flexibility</h3>
 	<p>Whatever the reason may be to use both the standard heading dropdown list or the separate heading toolbar buttons, <a href="https://ckeditor.com">CKEditor 5</a> WYSIWYG editor offers both of these options for greater comfort of rich-text edition and user satisfaction.</p>
 </div>

+ 5 - 1
packages/ckeditor5-heading/docs/features/headings.md

@@ -6,7 +6,9 @@ category: features
 
 {@snippet features/heading-source}
 
-The {@link module:heading/heading~Heading} feature enables support for headings. These are used by the creators to structure their documents. They also aid both the readers, making the content more organized and easier to read, and the search indexers scanning for crucial information. Headings can easily be added with toolbar dropdown, buttons or with {@link features/autoformat Markdown code} as you type. They can also be cleared with the {@link features/remove-format remove format} feature.
+The {@link module:heading/heading~Heading} feature enables support for headings. These are used by the creators to structure their documents. They also aid both the readers, making the content more organized and easier to read, and the search indexers scanning for crucial information.
+
+Headings can easily be added with toolbar dropdown, buttons or with {@link features/autoformat Markdown code} as you type. They can also be cleared with the {@link features/remove-format remove format} feature.
 
 <info-box info>
 	This feature is enabled by default in all builds.
@@ -28,6 +30,8 @@ By default, when your editor build does not include the title plugin, a `<h1>` e
 
 ## Demo
 
+Use toolbar dropdown to style a heading, or type # or more (depending on the heading level), followed by a space, to start a new heading with the {@link features/autoformat autoformatting feature}.
+
 {@snippet features/default-headings}
 
 ## Heading buttons