Browse Source

Docs: Added normal MD titles and removed blank framework guides. [skip ci]

Piotrek Koszuliński 8 years ago
parent
commit
6ae63bd2e8

+ 2 - 1
docs/builds/guides/browser-compatibility.md

@@ -1,9 +1,10 @@
 ---
-title: Browser compatibility
 category: builds-guides
 order: 310
 ---
 
+# Browser compatibility
+
 ## Desktop environment
 
 CKEditor 5 is currently supported on the following desktop browsers:

+ 1 - 1
docs/builds/guides/development/custom-builds.md

@@ -3,7 +3,7 @@
 # * Introduction to custom builds and why one would create them.
 # * Step-by-step instructions on creating a custom build.
 
-title: Custom builds
+menu-title: Custom builds
 category: builds-development
 order: 10
 ---

+ 2 - 1
docs/builds/guides/development/plugins.md

@@ -4,11 +4,12 @@
 # * Exemplify use cases.
 # * Point to resources to learn plugins development.
 
-title: Plugins
 category: builds-development
 order: 40
 ---
 
+# Plugins
+
 Features in CKEditor are introduced by plugins. In fact, without plugins CKEditor is an empty API with no use. The builds provided with CKEditor 5 are actually predefined collections of plugins, put together to satisfy specific needs.
 
 Plugins provided by the CKEditor core team are available in [npm](https://www.npmjs.com/search?q=ckeditor5) (and [GitHub](https://github.com/ckeditor?utf8=%E2%9C%93&q=ckeditor5&type=&language=), too) in form of npm packages. A package may contain one or more plugins (e.g. the [`@ckeditor/ckeditor5-image`](https://www.npmjs.com/package/@ckeditor/ckeditor5-image) packages contains {@link features/image several granular plugins}).

+ 7 - 0
docs/builds/guides/integration/advanced-setup.md

@@ -0,0 +1,7 @@
+---
+category: builds-integration
+order: 40
+---
+
+# Advanced setup
+

+ 2 - 1
docs/builds/guides/integration/basic-api.md

@@ -2,11 +2,12 @@
 # Scope:
 # * Guide developers through the basic API to achieve their very first results with CKEditor.
 
-title: Basic API
 category: builds-integration
 order: 20
 ---
 
+# Basic API
+
 Each CKEditor 5 build provides a different class that handles the creation of editor instances:
 
 * Classic editor – {@link module:editor-classic/classiceditor~ClassicEditor}

+ 2 - 1
docs/builds/guides/integration/configuration.md

@@ -4,11 +4,12 @@
 # * Introduction to the top and must-know configurations.
 # * Point where to find the list of configuration options.
 
-title: Configuration
 category: builds-integration
 order: 30
 ---
 
+# Configuration
+
 When creating an editor in your page, it is possible to set up {@link module:core/editor/editorconfig~EditorConfig configurations} that change many of its aspects. For example:
 
 ```js

+ 2 - 1
docs/builds/guides/integration/installation.md

@@ -2,11 +2,12 @@
 # Scope:
 # - Guidance on all possible installation options.
 
-title: Installation
 category: builds-integration
 order: 10
 ---
 
+# Installation
+
 ## Download options
 
 There are several options to download CKEditor 5 builds:

+ 2 - 1
docs/builds/guides/license-and-legal.md

@@ -2,11 +2,12 @@
 # Scope:
 # * Clarify copyright and license conditions.
 
-title: License and legal
 category: builds-guides
 order: 320
 ---
 
+# License and legal
+
 The following legal notices apply to CKEditor 5 Builds and all software from the CKEditor 5 Ecosystem included with it.
 
 Copyright (c) 2003-2017, CKSource Frederico Knabben. All rights reserved.

+ 2 - 1
docs/builds/guides/migrate.md

@@ -4,11 +4,12 @@
 # * Underline that migrating is a complex and important task.
 # * List and clarify the things that need attention when migrating.
 
-title: Migration from CKEditor 4
 category: builds-guides
 order: 260
 ---
 
+# Migration from CKEditor 4
+
 When compared to its previous versions, CKEditor 5 should be considered **a totally new editor**. Every single aspect of it was redesigned, from installation, to integration, to features, to its data model, and finally to its API. Therefore, moving applications using a previous version to version 5 cannot be simply called an "upgrade". It is something bigger, so the "migration" term fits better.
 
 There is no "drop in" solution for migrating. In this guide we hope to summarize the most important aspects to be taken into consideration before you proceed with installing CKEditor 5.

+ 2 - 1
docs/builds/guides/overview.md

@@ -5,11 +5,12 @@
 # * What is the difference with CKEditor 5 Framework?
 # * What is the difference with CKEditor 4?
 
-title: Overview
 category: builds-guides
 order: 10
 ---
 
+# Overview
+
 CKEditor 5 Builds are a set of ready to use rich text editors. Every "build" provides a single type of editor with a set of features and a default configuration. They provide convenient solutions that can be installed with no effort and that satisfy the most common editing use cases.
 
 ## Available builds

+ 2 - 1
docs/builds/guides/quick-start.md

@@ -2,11 +2,12 @@
 # Scope:
 # * TL;DR I want to run CKEditor 5.
 
-title: Quick start
 category: builds-guides
 order: 30
 ---
 
+# Quick start
+
 Creating an editor using a CKEditor 5 build is very simple and can be described in two steps:
 
 1. Load the desired editor via the `<script>` tag.

+ 2 - 1
docs/builds/guides/reporting-issues.md

@@ -4,11 +4,12 @@
 # * Drive the user to other parts of documentation.
 # * Bring knowledge for topics not covered in other parts of the documentation.
 
-title: Reporting issues
 category: builds-guides
 order: 330
 ---
 
+# Reporting issues
+
 If you feel you found an issue in CKEditor, we will be grateful for letting us know. Before you create a bug report, however, please read our guidelines on how to do it properly and most efficiently.
 
 ## Reproduce on official examples

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

@@ -3,12 +3,13 @@
 # * Highlight new things when compared to CKEditor 4.
 # * Emphasize cool new stuff we are bringing, for those learning about CKEditor 5.
 
-title: What's new in CKEditor 5?
 menu-title: What's new?
 category: builds-guides
 order: 20
 ---
 
+# What's new in CKEditor 5?
+
 ## Enhanced UX
 
 CKEditor 5 strives to provide a truly seamless, distraction-free editing experience to allow the users to focus on creating great content.

+ 0 - 7
docs/framework/guides/end-user-features/end-user-features.md

@@ -1,7 +0,0 @@
----
-title: End User Features Example Guide
-category: end-user-features
-slug: euf
-order: 90
----
-Lorem ipsum dolor sit amet, consectetur adipiscing elit.

+ 0 - 6
docs/framework/guides/getting-started/getting-started.md

@@ -1,6 +0,0 @@
----
-title: Getting started
-category: getting-started
-order: 50
----
-Lorem ipsum dolor sit amet, consectetur adipiscing elit.

+ 0 - 6
docs/framework/guides/inserting-ckeditor/another-guide.md

@@ -1,6 +0,0 @@
----
-title: Another guide about inserting CKEditor
-category: inserting-ckeditor
-order: 40
----
-Lorem ipsum dolor sit amet, consectetur adipiscing elit.

+ 0 - 6
docs/framework/guides/inserting-ckeditor/inserting.md

@@ -1,6 +0,0 @@
----
-title: Inserting
-category: inserting-ckeditor
-order: 40
----
-Lorem ipsum dolor sit amet, consectetur adipiscing elit.

+ 0 - 7
docs/framework/index.md

@@ -1,7 +0,0 @@
----
-title: Framework
-category: framework
-order: 10
----
-
-Framework's starting page.

+ 0 - 6
docs/framework/tutorials/advanced-tutorials/advanced.md

@@ -1,6 +0,0 @@
----
-title: Advanced Tutorial
-category: advanced-tutorials
-order: 30
----
-Lorem ipsum dolor sit amet, consectetur adipiscing elit.

+ 0 - 6
docs/framework/tutorials/how-to/how-to-artcle.md

@@ -1,6 +0,0 @@
----
-title: Another tutorial example
-category: how-to
-order: 30
----
-Lorem ipsum dolor sit amet, consectetur adipiscing elit.

+ 0 - 6
docs/framework/tutorials/index.md

@@ -1,6 +0,0 @@
----
-title: Tutorials Index Page
-category: tutorials
-order: 30
----
-

+ 0 - 6
docs/framework/tutorials/step-by-step/step-by-step-article.md

@@ -1,6 +0,0 @@
----
-title: Example Tutorial
-category: step-by-step
-order: 30
----
-Lorem ipsum dolor sit amet, consectetur adipiscing elit.