Bladeren bron

Docs: Minor improvements. [skip ci]

Piotrek Koszuliński 8 jaren geleden
bovenliggende
commit
35f19b953d

+ 3 - 2
docs/api/index.md

@@ -1,10 +1,11 @@
 ---
-title: API documentation
 category: api-reference
 ---
 
+# API documentation
+
 <info-box>
-Use the **navigation tree on the left** to navigate through CKEditor API.
+	Use the **navigation tree on the left** to navigate through CKEditor API.
 </info-box>
 
 ## Popular API pages

+ 2 - 2
docs/builds/guides/whats-new.md

@@ -83,8 +83,8 @@ A much more efficient data model was designed for CKEditor 5. This makes the dev
 Another important benefit of the custom data model is that it enables the possibility of real-time collaborative editing inside CKEditor by introducing the concepts of "operations" and "operational transformations".
 
 <!--
- Read more about {@linkTODO collaboration in the CKEditor 5 Framework documentation}.
- -->
+Read more about {@linkTODO collaboration in the CKEditor 5 Framework documentation}.
+-->
 
 <!-- TODO 3 -->
 

+ 2 - 3
docs/builds/index.md

@@ -1,5 +1,4 @@
 ---
-title: Builds
 category: builds
 order: 10
 toc: false
@@ -10,10 +9,10 @@ toc: false
 CKEditor 5 Builds are the fastest and easiest way to use CKEditor 5 in your application.
 
 <info-box>
-Use the **navigation tree on the left** to navigate through CKEditor 5 Builds documentation.
+	Use the **navigation tree on the left** to navigate through CKEditor 5 Builds documentation.
 </info-box>
 
-## Related links 
+## Related links
 
  * {@link examples/index Examples} &ndash; Try live demos of all available builds.
  * {@link features/index Features} &ndash; Learn about some of the features included in CKEditor 5 Builds.

+ 2 - 1
docs/examples/builds/balloon-editor.md

@@ -1,9 +1,10 @@
 ---
-title: Balloon editor
 category: examples-builds
 order: 30
 ---
 
+# Balloon editor
+
 {@link builds/guides/overview#Balloon-editor Balloon editor} example.
 
 {@snippet examples/balloon-editor}

+ 2 - 1
docs/examples/builds/classic-editor.md

@@ -1,9 +1,10 @@
 ---
-title: Classic editor
 category: examples-builds
 order: 10
 ---
 
+# Classic editor
+
 {@snippet build-classic-source}
 
 {@link builds/guides/overview#Classic-editor Classic editor} example.

+ 2 - 1
docs/examples/builds/inline-editor.md

@@ -1,9 +1,10 @@
 ---
-title: Inline editor
 category: examples-builds
 order: 20
 ---
 
+# Inline editor
+
 {@link builds/guides/overview#Inline-editor Inline editor} example.
 
 {@snippet examples/inline-editor}

+ 4 - 3
docs/examples/index.md

@@ -1,15 +1,16 @@
 ---
-title: Examples
 category: examples
 order: 10
 toc: false
 ---
 
+# Examples
+
 <info-box>
-Use the **navigation tree on the left** to navigate through CKEditor 5 examples.
+	Use the **navigation tree on the left** to navigate through CKEditor 5 examples.
 </info-box>
 
-## Related links 
+## Related links
 
  * {@link features/index Features} &ndash; Learn about some of the features included in CKEditor 5 Builds.
  * {@link builds/guides/overview CKEditor 5 Builds} &ndash; Learn how to install, integrate and configure CKEditor 5 Builds. More complex aspects, like creating custom builds, are explained here, too.</dd>

+ 5 - 6
docs/features/index.md

@@ -1,25 +1,24 @@
 ---
-title: Features
 category: features
 order: 10
 toc: false
 ---
 
+# Features
+
 <info-box>
-Use the **navigation tree on the left** to navigate through selected CKEditor 5 features.
+	Use the **navigation tree on the left** to navigate through selected CKEditor 5 features.
 </info-box>
 
 ## Features availability
 
-Most of the features are included in CKEditor 5 Builds and are available out of the box, like for example {@link features/autoformat Autoformatting}
-or {@link features/keyboard-support Keyboard support}. However, some of the presented features need to be manually included 
-in a customized CKEditor build, for example the {@link features/markdown Markdown processor} which outputs Markdown instead of HTML.
+Most of the features are included in CKEditor 5 Builds and are available out of the box, like for example {@link features/autoformat Autoformatting} or {@link features/keyboard-support Keyboard support}. However, some of the presented features need to be manually included in a customized CKEditor build, for example the {@link features/markdown Markdown processor} which outputs Markdown instead of HTML.
 
 ## Looking for more?
 
 The examples on the left do not present all features included in CKEditor 5. For example some end-user features like bulleted and numbered lists are quite self-explanatory.
 
-Please bear in mind that the stable version of CKEditor 5 has not been officially released yet and with time more features will be added to CKEditor 5. If you are missing anything particular, feel free to [suggest a new feature](https://github.com/ckeditor/ckeditor5/issues) and share your feedback with us. If it has already been reported by someone else, upvote it to show your support. 
+Please bear in mind that the stable version of CKEditor 5 has not been officially released yet and with time more features will be added to CKEditor 5. If you are missing anything particular, feel free to [suggest a new feature](https://github.com/ckeditor/ckeditor5/issues) and share your feedback with us. If it has already been reported by someone else, upvote it to show your support.
 
 ## How about creating your own features?
 

+ 2 - 1
docs/features/keyboard-support.md

@@ -1,9 +1,10 @@
 ---
-title: Keyboard support
 category: features
 classes: keyboard-shortcuts
 ---
 
+# Keyboard support
+
 Below is a list of the most important keystrokes supported by CKEditor 5 and its features:
 
 | Action | PC | Mac |

+ 2 - 1
docs/features/read-only.md

@@ -1,8 +1,9 @@
 ---
-title: Read-only support
 category: features
 ---
 
+# Read-only support
+
 {@snippet build-classic-source}
 
 The editor can be set into a read-only mode by changing the value of the {@link module:core/editor/editor~Editor#isReadOnly `Editor#isReadOnly`} property.

+ 3 - 2
docs/features/ui-language.md

@@ -1,8 +1,9 @@
 ---
-title: Setting the editor UI language
 category: features
 ---
 
+# Setting the UI language
+
 The UI of the editor can be localized. CKEditor 5 currently supports around 20 languages and the number is growing.
 
 If you want to help translate CKEditor 5 into your native language, join the [CKEditor 5 project on Transifex](https://www.transifex.com/ckeditor/ckeditor5/). Your help will be much appreciated!
@@ -21,7 +22,7 @@ If you build CKEditor from scratch or integrate it directly into your applicatio
 
 1. Install the [`@ckeditor/ckeditor5-dev-webpack-plugin`](https://www.npmjs.com/package/@ckeditor/ckeditor5-dev-webpack-plugin) package:
 
-	```
+	```bash
 	npm install --save @ckeditor/ckeditor5-dev-webpack-plugin
 	```
 

+ 1 - 2
docs/framework/index.md

@@ -1,5 +1,4 @@
 ---
-title: Framework
 category: framework
 order: 10
 toc: false
@@ -19,7 +18,7 @@ Use the **navigation tree on the left** to navigate through CKEditor 5 Framework
  * {@link examples/index Examples} &ndash; Try live demos of all available builds. View some of the possible customizations of CKEditor.
 
 <info-box>
-The CKEditor 5 Framework documentation is still in progress, so it may be lacking many things. Feel free to [suggest documentation enhancements](https://github.com/ckeditor/ckeditor5/labels/type%3Adocs) and share your feedback about the framework. 
+The CKEditor 5 Framework documentation is still in progress, so it may be lacking many things. Feel free to [suggest documentation enhancements](https://github.com/ckeditor/ckeditor5/labels/type%3Adocs) and share your feedback about the framework.
 
 If the documentation is insufficient, please do not be afraid of looking into the source code of [CKEditor 5 packages](https://github.com/ckeditor?utf8=%E2%9C%93&q=ckeditor5&type=public). For example if you plan to create a new feature, check if a similar feature already exists and try to take inspiration from its source code.
 </info-box>

+ 3 - 2
docs/index.md

@@ -1,9 +1,10 @@
 ---
-title: CKEditor 5 documentation
 toc: false
 sitenav: false
 ---
 
+# CKEditor 5 documentation
+
 <dl><dt>{@link builds/guides/overview CKEditor 5 Builds documentation}</dt><dd>Learn how to install, integrate and configure CKEditor 5 Builds. More complex aspects, like creating custom builds, are explained here, too.</dd>
 <dt>{@link framework/guides/overview CKEditor 5 Framework documentation}</dt><dd>Learn how to work with CKEditor 5 Framework, customize it, create your own plugins and custom editors, change the UI or even bring your own UI to the editor.</dd>
 <dt>{@link examples/index CKEditor 5 Examples}<dt><dd>Try out all CKEditor 5 Builds. See some of the possible customizations of CKEditor.</dd>
@@ -12,4 +13,4 @@ sitenav: false
 
 ## Contribute
 
-CKEditor is an Open Source project and your contribution is most welcome. Feel free to {@link builds/guides/reporting-issues report bugs} or improve the code on [GitHub](https://github.com/ckeditor/ckeditor5). Since CKEditor is localized, you can also help [to translate it](https://www.transifex.com/ckeditor/ckeditor5/). You do not need to be a programmer to contribute to the project! 
+CKEditor is an Open Source project and your contribution is most welcome. Feel free to {@link builds/guides/reporting-issues report bugs} or improve the code on [GitHub](https://github.com/ckeditor/ckeditor5). Since CKEditor is localized, you can also help [to translate it](https://www.transifex.com/ckeditor/ckeditor5/). You do not need to be a programmer to contribute to the project!