浏览代码

Docs: Reworked introductions to each part of the documentation. [skip ci]

Wiktor Walc 8 年之前
父节点
当前提交
3927bd0fa1
共有 7 个文件被更改,包括 127 次插入51 次删除
  1. 3 1
      docs/api/index.md
  2. 6 10
      docs/builds/index.md
  3. 10 1
      docs/examples/index.md
  4. 23 1
      docs/features/index.md
  5. 19 1
      docs/framework/index.md
  6. 30 1
      docs/index.md
  7. 36 36
      docs/umberto.json

+ 3 - 1
docs/api/index.md

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

+ 6 - 10
docs/builds/index.md

@@ -9,15 +9,11 @@ toc: false
 
 CKEditor 5 Builds are the fastest and easiest way to use CKEditor 5 in your application.
 
-## Documentation 
+<info-box>
+Use the **navigation tree on the left** to navigate through CKEditor 5 Builds documentation.
+</info-box>
 
- * {@link builds/guides/overview Guides} &ndash; Learn how to install, integrate and configure CKEditor 5 Builds. More complex aspects, like creating custom builds, are explained here, too.
- * {@link features/index Features} &ndash; Learn about some of the features included in CKEditor 5 Builds.
-
-## Examples
-
-Try {@link examples/index live demos} of all available builds.
+## Related links 
 
-## 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!
+ * {@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.

+ 10 - 1
docs/examples/index.md

@@ -2,6 +2,15 @@
 title: Examples
 category: examples
 order: 10
+toc: false
 ---
 
-Examples's starting page.
+<info-box>
+Use the **navigation tree on the left** to navigate through CKEditor 5 examples.
+</info-box>
+
+## 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>
+ * {@link framework/guides/overview CKEditor 5 Framework} &ndash; Learn how to work with CKEditor 5 Framework, customize it, create your own plugins, custom editors, how to change the UI or even bring your own UI to the editor.

+ 23 - 1
docs/features/index.md

@@ -2,6 +2,28 @@
 title: Features
 category: features
 order: 10
+toc: false
 ---
 
-Features' starting page.
+<info-box>
+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 Builds and 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 & numbered lists are quite self-explanatory.
+
+Please bear in mind that the stable version of CKEditor 5 has not been officially released yet, 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 with us your feedback. If it has been already reported by someone, upvote it to show your support. 
+
+## How about creating own features?
+
+Probably the most exciting features are the one you can develop on top of CKEditor 5 Framework!
+We are slowly enhancing the {@link framework/index CKEditor 5 Framework documentation}, together with {@link api/index API documentation} hoping to give you a solid base for {@link framework/guides/quick-start#Creating-a-simple-plugin creating own features}.
+
+The addons community in case of CKEditor 4 resulted in an impressive number of over 300 addons created and published by the community. Now it's time for CKEditor 5!

+ 19 - 1
docs/framework/index.md

@@ -2,6 +2,24 @@
 title: Framework
 category: framework
 order: 10
+toc: false
 ---
 
-Framework's starting page.
+# CKEditor 5 Framework
+
+CKEditor 5 Framework is a set of components enabling you to create any kind of text editing solution.
+
+<info-box>
+Use the **navigation tree on the left** to navigate through CKEditor 5 Framework documentation.
+</info-box>
+
+## Related links
+
+ * {@link features/index Features} &ndash; Learn about some of the features included in the 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>
+Framework documentation is still in progress, so it may be still lacking many things. Feel free to [suggest documentation enhancements](https://github.com/ckeditor/ckeditor5/issues) and share with us 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 an inspiration from its source code.
+</info-box>

+ 30 - 1
docs/index.md

@@ -1,5 +1,34 @@
 ---
 title: CKEditor 5 documentation
+toc: false
 ---
 
-What could we have here?
+<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, custom editors, how to 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>
+<dt>{@link features/index CKEditor 5 Features}</dt><dd>Learn about selected features included in CKEditor 5 Builds.</dd>
+<dt>{@link api/index CKEditor 5 API Reference}</dt><dd>A complete API documentation.</dd></dl>
+
+## 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! 
+
+<style>
+/* Temporary hack until Umberto supports this internally. */
+dl {
+  margin-top:1em;
+}
+.main .side-navigation {
+  display:none;
+}
+.main .main__content {
+  padding-right:0;
+}
+.main .main__content-inner {
+  width: auto;
+  max-width: 860px;
+  margin: auto;
+  padding-left: 50px;
+  padding-right: 50px;
+}
+</style>

+ 36 - 36
docs/umberto.json

@@ -13,11 +13,30 @@
 	},
 	"groups": [
 		{
-			"name": "API",
-			"id": "api-reference",
-			"sourceDir": "api",
-			"slug": "api",
-			"type": "jsdoc"
+			"name": "Builds",
+			"id": "builds",
+			"slug": "builds",
+			"categories": [
+				{
+					"name": "Guides",
+					"id": "builds-guides",
+					"slug": "guides",
+					"categories": [
+						{
+							"name": "Integration",
+							"id": "builds-integration",
+							"slug": "integration",
+							"order": 100
+						},
+						{
+							"name": "Development",
+							"id": "builds-development",
+							"slug": "development",
+							"order": 200
+						}
+					]
+				}
+			]
 		},
 		{
 			"name": "Framework",
@@ -52,37 +71,6 @@
 			]
 		},
 		{
-			"name": "Builds",
-			"id": "builds",
-			"slug": "builds",
-			"categories": [
-				{
-					"name": "Guides",
-					"id": "builds-guides",
-					"slug": "guides",
-					"categories": [
-						{
-							"name": "Integration",
-							"id": "builds-integration",
-							"slug": "integration",
-							"order": 100
-						},
-						{
-							"name": "Development",
-							"id": "builds-development",
-							"slug": "development",
-							"order": 200
-						}
-					]
-				}
-			]
-		},
-		{
-			"name": "Features",
-			"id": "features",
-			"slug": "features"
-		},
-		{
 			"name": "Examples",
 			"id": "examples",
 			"slug": "examples",
@@ -98,6 +86,18 @@
 					"slug": "framework"
 				}
 			]
+		},
+		{
+			"name": "Features",
+			"id": "features",
+			"slug": "features"
+		},
+		{
+			"name": "API",
+			"id": "api-reference",
+			"sourceDir": "api",
+			"slug": "api",
+			"type": "jsdoc"
 		}
 	],
 	"items": [