Skip to content

Latest commit

 

History

History
52 lines (30 loc) · 2.52 KB

README.md

File metadata and controls

52 lines (30 loc) · 2.52 KB
Raw

ThisNetWorks.OrchardCore.CKEditor

CKEditor 5 classic build with media plugins for Orchard Core.

Features

  • Html Field and Html Body Part editor modes for CKEditor 5.
  • Reusable plugin / editor toolbar configurations.

Getting Started

  • Install the ThisNetWorks.OrchardCore.CKEditor module to your Orchard Core Host project.
  • Enable the CKEditors feature.
  • Change the editor mode for either an Html Field, or Html Body Part, in the Content Definitions to CKEditor.
  • Select either the Default Configuration or a custom configuration.

Samples

There is a sample project which includes custom configurations for the CKEditor toolbar.

To install run the CK Editor Sample recipe.

CK Editor Configurations are found in the Configuration -> CKEditor Configurations menu.

These include toolbar styling options, and an example of how to apply styling to TheAdmin theme.

Configurations

Different toolbar configurations are available. Please refer to the CKEditor 5 configuration documentation

Notes

This project is a light wrapper around CKEditor5 to provide alternates to the default editors, and access to the media library.

For further customization of builds, alternate editors, etc, please refer to the CKEditor 5 documentation

Versions

Version tags and pre release suffixes are based of the version of Orchard Core referenced.

For version 1.0 of Orchard Core use 1.0.0, which will use the Orchard Core NuGet Feed.

Prerelease versions are suffixed with the CloudSmith build of Orchard Core referenced, and will required a configured CloudSmith NuGet feed. Refer Configuring a preview package source

e.g. 1.1.0-preview-16439 refers to the CloudSmith Orchard Core prerelease build v1.1.0-preview-16439

License

ThisNetworks.OrchardCore.CKEditor licensed under the terms of the BSD-3-Clause License.

CKEditor5 Classic Build redistributed under the the terms of GNU General Public License Version 2 or later. For full details about the license, please check the LICENSE.md file or https://ckeditor.com/legal/ckeditor-oss-license.