Skip to content

Commit

Permalink
Merge stable into master
Browse files Browse the repository at this point in the history
  • Loading branch information
CKEditorBot committed Oct 11, 2023
2 parents 0ba85c1 + ca5c973 commit c3fc28a
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 3 deletions.
28 changes: 25 additions & 3 deletions docs/examples/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
category: examples
order: 10
meta-title: CKEditor 5 online examples | CKEditor 5 Documentation
meta-description: Navigate through CKEditor 5 examples to see what you are able to create using this rich text editing framework.
menu-title: Overview
meta-description: Navigate through CKEditor 5 examples to see what you can create using this rich text editing framework.
---

# Examples
Expand All @@ -15,8 +16,29 @@ Check out these examples of different editor integrations. See the predefined bu
</info-box>
</span>

## Predefined builds

{@link installation/getting-started/predefined-builds Predefined CKEditor&nbsp;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 cover the most common editing use cases, and you can install them easily. See all of them in action: {@link examples/builds/classic-editor classic}, {@link examples/builds/inline-editor inline}, {@link examples/builds/balloon-editor balloon}, {@link examples/builds/balloon-block-editor balloon block}, {@link examples/builds/document-editor document}, and {@link examples/builds/multi-root-editor multi-root} editors! Learn their differences by using our examples and analyzing the source code of the builds.

## Advanced custom builds

CKEditor&nbsp;5 is a configurable framework created with collaboration in mind. It lets you build a custom editor of any type, with a wide set of features and the toolbar type that you need where multiple authors can easily work on the same rich text documents. Check out our {@link examples/builds/full-featured-editor feature-rich editor} that sports as many plugins as possible to put together. Want to invite some friends? Try the {@link examples/builds/collaborative-document-editor collaborative document editor} that brings the experience of the most popular online editing solutions to the table. And witness the flexibility of the UI in the {@link examples/custom/bottom-toolbar-editor toolbar-oriented example}.

## Framework examples

{@link framework/index CKEditor&nbsp;5 Framework} is a highly flexible and universal platform that provides a set of components allowing you to create any kind of rich text editor. It enables the integrators to build different, custom-tailored editing solutions with {@link examples/custom-ui custom UI} or {@link examples/theme-customization a theme} that suit their specific needs. It also provides tools for the creating and integrating of {@link examples/framework/data-from-external-source some user-made}, {@link examples/framework/content-placeholder custom features} and for customizing {@link examples/chat-with-mentions existing ones}. See how CKEditor 5 can integrate a {@link examples/framework/using-react-in-a-widget React library} to enrich both the contents and the editing experience.

## Experimental solutions

If you need even more, try our experimental plugins, like the integration of the {@link examples/experiments/mermaid Mermaid library} that can be used to display flowcharts and diagrams.

## How-tos

There come times when you don't need deep-dive guides, elaborate solutions, and complicated examples. Sometimes, you just need to know how to set the height of CKEditor&nbsp;5. Or, maybe you want to learn how to focus the editor? This is what the {@link examples/how-tos How-to} section is for!


**Related links**

* {@link installation/index CKEditor&nbsp;5 installation} &ndash; Learn how to install, integrate and configure CKEditor&nbsp;5. More complex aspects, like creating custom builds, are explained here, too.
* {@link tutorials/index CKEditor&nbsp;5 tutorials} &ndash; A set of easy-to-follow, clear, and informative guides that will help you tailor the editor to your needs.
* {@link features/index CKEditor&nbsp;5 features} &ndash; Learn more about the available CKEditor&nbsp;5 features.
* {@link framework/index CKEditor&nbsp;5 Framework} &ndash; Learn how to work with CKEditor&nbsp;5 Framework, customize it, create your own plugins and custom editors, how to change the UI, or even bring your own UI to the editor.
* {@link framework/index CKEditor&nbsp;5 Framework} &ndash; Learn how to work with CKEditor&nbsp;5 Framework, customize it, create your own plugins and custom editors, change the UI, or even bring your own UI to the editor.
1 change: 1 addition & 0 deletions docs/umberto.json
Original file line number Diff line number Diff line change
Expand Up @@ -520,6 +520,7 @@
"name": "Examples",
"id": "examples",
"slug": "examples",
"navigationIncludeIndex": true,
"categories": [
{
"name": "Predefined builds",
Expand Down

0 comments on commit c3fc28a

Please sign in to comment.