Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mlewand/ckeditor5
A playground repository for turning CKEditor 5 multirepo into a monorepo
https://github.com/mlewand/ckeditor5
Last synced: about 2 months ago
JSON representation
A playground repository for turning CKEditor 5 multirepo into a monorepo
- Host: GitHub
- URL: https://github.com/mlewand/ckeditor5
- Owner: mlewand
- License: other
- Created: 2020-03-24T13:05:22.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-11T21:26:13.000Z (about 2 years ago)
- Last Synced: 2024-10-14T12:55:18.589Z (3 months ago)
- Language: Rich Text Format
- Homepage:
- Size: 118 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
CKEditor 5 [](https://twitter.com/intent/tweet?text=Check%20out%20CKEditor%205%20on%20GitHub&url=https%3A%2F%2Fgithub.com%2Fckeditor%2Fckeditor5)
===================================
[](https://www.npmjs.com/package/ckeditor5)
[](https://travis-ci.org/ckeditor/ckeditor5)
[](https://david-dm.org/ckeditor/ckeditor5)
[](https://david-dm.org/ckeditor/ckeditor5?type=dev)
[](http://eepurl.com/c3zRPr)
[](https://twitter.com/ckeditor)
A set of ready-to-use rich text editors created with a powerful framework. Made with real-time collaborative editing in mind.
## ⚠ This package does not contain any source code
CKEditor 5 is distributed as [several ready-to-use rich text editor builds](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/overview.html#available-builds) which you can [install from npm](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/installation.html#npm).
You can also [customize the existing builds](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/development/custom-builds.html) or build your own editors and features by using the [CKEditor 5 Framework](https://ckeditor.com/docs/ckeditor5/latest/framework/guides/overview.html).
## Table of contents
* [Quick start](#quick-start)
* [CKEditor 5 Builds](#ckeditor-5-builds)
* [CKEditor 5 Framework](#ckeditor-5-framework)
* [Documentation and FAQ](#documentation-and-faq)
* [Contributing and project organization](#contributing-and-project-organization)
* [Ideas and discussions](#ideas-and-discussions)
* [Development](#development)
* [Reporting issues and feature requests](#reporting-issues-and-feature-requests)
* [Releases](#releases)
* [Packages](#packages)
* [Core libraries](#core-libraries)
* [Builds](#builds)
* [Features](#features)
* [Editors](#editors)
* [Themes](#themes)
* [License](#license)
## Quick start
### CKEditor 5 Builds
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.
The following CKEditor 5 Builds are currently available:
* [Classic editor](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/overview.html#classic-editor)
* [Inline editor](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/overview.html#inline-editor)
* [Balloon editor](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/overview.html#balloon-editor)
* [Balloon block editor](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/overview.html#balloon-block-editor)
* [Document editor](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/overview.html#document-editor)
#### Example
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 `` tag.
2. Call the static `create()` method to create the editor.
In your HTML page add an element that CKEditor should replace:
```html
<div id="editor"></div>
```
Load the classic editor build (you can choose between [CDN](https://cdn.ckeditor.com/#ckeditor5), [npm](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/installation.html#npm) and [zip downloads](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/installation.html#zip-download)):
```html
<script src="https://cdn.ckeditor.com/ckeditor5/<version>/classic/ckeditor.js">
```
Call the [`ClassicEditor.create()`](https://ckeditor.com/docs/ckeditor5/latest/api/module_editor-classic_classiceditor-ClassicEditor.html#static-function-create) method:
```html
ClassicEditor
.create( document.querySelector( '#editor' ) )
.catch( error => {
console.error( error );
} );
```
You’re ready to go!
To find out how to start with other builds check the [Quick start guide in the CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/builds/guides/quick-start.html).
### CKEditor 5 Framework
CKEditor 5 Builds allow you to quickly and easily initialize one of the many types of editors in your application. At the same time, CKEditor 5 is also a framework for creating custom-made rich text editing solutions.
To find out how to start building your own editor from scratch go to [CKEditor 5 Framework overview section of CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/framework/guides/overview.html).
## Documentation and FAQ
To find out more see the following [CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/index.html) sections:
* [API documentation](https://ckeditor.com/docs/ckeditor5/latest/api/index.html)
* [CKEditor 5 Framework documentation](https://ckeditor.com/docs/ckeditor5/latest/framework/index.html)
* [CKEditor 5 Builds documentation](https://ckeditor.com/docs/ckeditor5/latest/builds/index.html)
* [CKEditor 5 Features documentation](https://ckeditor.com/docs/ckeditor5/latest/features/index.html)
* [CKEditor 5 Examples](https://ckeditor.com/docs/ckeditor5/latest/examples/index.html)
The documentation is far from being complete and will be constantly evolving (as will the editor) until it is ready for v1.0.0.
For FAQ please go to the [CKEditor Ecosystem help center](https://support.ckeditor.com/hc/en-us).
For a high-level overview of the project see the [CKEditor Ecosystem website](https://ckeditor.com).
## Contributing and project organization
### Ideas and discussions
The main development repository of CKEditor 5 is located at [https://github.com/ckeditor/ckeditor5](https://github.com/ckeditor/ckeditor5). This is the best place for bringing opinions and contributions. Letting the core team know if they are going in the right or wrong direction is great feedback and will be much appreciated!
### Development
CKEditor 5 is a modular, multi-package, multi-repository project. It consists of several packages that create the editing framework, based on which the feature packages are implemented.
The [ckeditor5](https://github.com/ckeditor/ckeditor5) repository is the place that centralizes the development of CKEditor 5. It bundles different packages into a single place, adding the necessary helper tools for the development workflow, like the builder and the test runner. [Basic information on how to set up the development environment](https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/development-environment.html) can be found in the documentation.
See the [official contributors' guide](https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html) to learn how to contribute your code to the project.
### Reporting issues and feature requests
Each repository handles its issues independently. However, it is recommended to report issues in [this repository](https://github.com/ckeditor/ckeditor5/issues) unless you know to which specific repository the issue belongs.
Read more on the [Support](https://ckeditor.com/docs/ckeditor5/latest/framework/guides/support/getting-support.html) page.
## Releases
See CKEditor 5 release blog posts [on the CKEditor blog](https://ckeditor.com/blog/?category=releases&tags=CKEditor-5).
## Packages
### Core libraries
Name
Version
Description
@ckeditor/ckeditor5-engine
The editing engine.
@ckeditor/ckeditor5-core
The core editor architecture.
@ckeditor/ckeditor5-ui
The editor UI library.
@ckeditor/ckeditor5-utils
The editor utilities library.
@ckeditor/ckeditor5-upload
The file upload utilities.
@ckeditor/ckeditor5-widget
The widget API.
@ckeditor/ckeditor5-watchdog
The watchdog feature, which keeps CKEditor 5 editors running.
@ckeditor/ckeditor5-cloud-services
CKEditor 5's Cloud Services integration layer.
@ckeditor/ckeditor-cloud-services-core
CKEditor Cloud Services integration utils.
### Builds
Name
Version
Description
@ckeditor/ckeditor5-build-classic
The classic editor build.
@ckeditor/ckeditor5-build-inline
The inline editor build.
@ckeditor/ckeditor5-build-balloon
The balloon editor (Medium-like) build.
@ckeditor/ckeditor5-build-balloon-block
The balloon editor with a block toolbar (Slack–like) build.
@ckeditor/ckeditor5-build-decoupled-document
The document editor build, featuring the decoupled UI editor implementation.
### Features
Name
Version
Description
@ckeditor/ckeditor5-adapter-ckfinder
The CKFinder adapter for features which require upload capabilities (e.g. image upload).
@ckeditor/ckeditor5-alignment
The text alignment feature.
@ckeditor/ckeditor5-autoformat
The autoformatting feature. Replaces predefined characters with a corresponding format (e.g. **foo** becomes bold <strong>foo</strong>).
@ckeditor/ckeditor5-autosave
The autosave feature. Makes it easy to automatically save the data to the backend.
@ckeditor/ckeditor5-basic-styles
The bold, italic, underline and code features.
@ckeditor/ckeditor5-block-quote
The block quote feature.
@ckeditor/ckeditor5-ckfinder
The CKFinder file browser integration.
@ckeditor/ckeditor5-clipboard
The clipboard integration.
@ckeditor/ckeditor5-code-block
The code block feature.
@ckeditor/ckeditor5-enter
The Enter key feature.
@ckeditor/ckeditor5-easy-image
Easy Image with CKEditor Cloud Services feature.
@ckeditor/ckeditor5-font
The font size and font family features.
@ckeditor/ckeditor5-heading
The heading feature.
@ckeditor/ckeditor5-highlight
The highlight feature (markers and pens).
@ckeditor/ckeditor5-horizontal-line
The horizontal rule feature.
@ckeditor/ckeditor5-image
The image feature. Supports image styles, captioning, upload, resizing, and more.
@ckeditor/ckeditor5-indent
The indentation (of lists and blocks) feature.
@ckeditor/ckeditor5-link
The link feature.
@ckeditor/ckeditor5-list
The numbered and bulleted lists feature.
@ckeditor/ckeditor5-markdown-gfm
The GitHub-flavored Markdown data processor.
@ckeditor/ckeditor5-media-embed
The media embed feature.
@ckeditor/ckeditor5-mention
The mention feature (autocomplete `@mentions`, `#tags`, etc.).
@ckeditor/ckeditor5-page-break
The page break feature.
@ckeditor/ckeditor5-paragraph
The paragraph feature.
@ckeditor/ckeditor5-paste-from-office
The Paste from Office (Word, Excel, Google Docs, etc.) plugin.
@ckeditor/ckeditor5-remove-format
The remove format feature.
@ckeditor/ckeditor5-restricted-editing
The restricted editing feature.
@ckeditor/ckeditor5-select-all
The "select all" feature.
@ckeditor/ckeditor5-special-characters
The special characters feature.
@ckeditor/ckeditor5-table
The table feature.
@ckeditor/ckeditor5-typing
The typing and deleting features.
@ckeditor/ckeditor5-undo
The undo feature.
@ckeditor/ckeditor5-word-count
The word count feature.
### Editors
Name
Version
Description
@ckeditor/ckeditor5-editor-classic
The classic editor implementation.
@ckeditor/ckeditor5-editor-inline
The inline editor implementation.
@ckeditor/ckeditor5-editor-balloon
The balloon editor (Medium-like) implementation.
@ckeditor/ckeditor5-editor-decoupled
The editor implementation with a decoupled UI.
### Themes
Name
Version
Description
@ckeditor/ckeditor5-theme-lark
The Lark theme.
## License
Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html). For full details about the license, please check the `LICENSE.md` file or [https://ckeditor.com/legal/ckeditor-oss-license](https://ckeditor.com/legal/ckeditor-oss-license).