Git Product home page Git Product logo

ckeditor5-build-classic's Introduction

NOTE: This fork has been discontinued, since I opted for a local version of the build. If you would like to create your own personalized local version as well, do the following steps:

  • Fork the ckeditor build within a folder on your project (ie. project/external)
  • In the forked directory, run npm install
  • Adjust the build as you would like, adding, removing and configuring your editor
  • Perform yarn build in the forked directory
  • Add the build to the package.json dependencies (ex: "my-custom-build": "file:./external/ckeditor-build-classic")
  • In your file, import the build (ex: import ClassicEditor from 'my-custom-build')

You now have a local customizable version of the editor. This can also be applied to other packages, as long as you have the source code. Also, if you have the git still initialized to the upstream fork, you can always perform updates to your build whenever they are available (see Updating the build)

CKEditor 5 Classic Plus

npm version Build Status
Dependency Status devDependency Status

The classic editor build for CKEditor 5. Read more about the classic editor build and see the demo.

This specific build has been adjusted to use some existing plugins, plus multiple additional plugins. See Additional Plugins.

CKEditor 5 classic editor build screenshot

Enabled Default Plugins

  • Essentials
  • UploadAdapter
  • Autoformat
  • Bold
  • Italic
  • Underline
  • Strikethrough
  • SuperScript
  • SubScript
  • Code
  • BlockQuote
  • CKFinder
  • EasyImage
  • Heading
  • Image
  • ImageCaption
  • ImageStyle
  • ImageToolbar
  • ImageUpload
  • Indent
  • Link
  • List
  • MediaEmbed
  • Paragraph
  • PasteFromOffice
  • Table
  • TableToolbar
  • Alignment
  • Autosave
  • Highlight
  • PendingActions
  • SimpleUploadAdapter
  • Font
  • ImageResize

Documentation

See:

Quick start

First, install the build from npm:

npm install --save ckeditor5-build-classic-plus

And use it in your website:

<div id="editor">
	<p>This is the editor content.</p>
</div>
<script src="./node_modules/ckeditor5-build-classic-plus/build/ckeditor.js"></script>
<script>
	ClassicEditor
		.create( document.querySelector( '#editor' ) )
		.then( editor => {
			window.editor = editor;
		} )
		.catch( err => {
			console.error( err.stack );
		} );
</script>

Or in your JavaScript application:

import ClassicEditor from 'ckeditor5-build-classic-plus';

// Or using the CommonJS version:
// const ClassicEditor = require( 'ckeditor5-build-classic-plus' );

ClassicEditor
	.create( document.querySelector( '#editor' ) )
	.then( editor => {
		window.editor = editor;
	} )
	.catch( err => {
		console.error( err.stack );
	} );

Note: If you are planning to integrate CKEditor 5 deep into your application, it is actually more convenient and recommended to install and import the source modules directly (like it happens in ckeditor.js). Read more in the Advanced setup guide.

License

Licensed under 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.

ckeditor5-build-classic's People

Contributors

reinmar avatar oleq avatar ma2ciek avatar jodator avatar pomek avatar mlewand avatar szymonkups avatar annatomanek avatar flamingfox911 avatar rajasa avatar onurozkan avatar wwalc avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.