Git Product home page Git Product logo

strapi-plugin-ckeditor-markdown's Introduction

Strapi CKEditor5 plugin

Replace default Strapi markdown WYSIWYG editor with enhanced build of HTML CKEditor 5.

strapi-plugin-ckeditor5

Sample for this article.

๐Ÿ‘€ Live Demo

Features

  • Enhanced build of CKEditor 5 with more capabilities then Classic Editor build
  • Extensive set of features for your rich content
  • Optional editor customization
  • Automatically upload Inserted images to Media Library (thanks to ckeditor5-strapi-upload-plugin)
  • Media Library button to insert stored images directly to the editor ๐Ÿ”ฅ
  • Automatic translation of UI into selected in Strapi language ๐Ÿ”ฅ
  • Full screen mode ๐Ÿ”ฅ

How to try

Check out ๐Ÿ‘€ live demo where you can test most of the features.

How to install

Go to your Strapi project folder and execute

npm i strapi-plugin-ckeditor5

Don't forget to rebuild Strapi

npm run strapi build

How to remove unused buttons

See customization guide.

How to customize editor (optional)

If you want to change appearance of the editor or remove unused buttons you can add a custom CKEditor configuration to override default settings:

  1. Go to your Strapi folder

  2. Copy template config file node_modules/strapi-plugin-ckeditor5/admin/src/config/ckeditor.js to extensions/ckeditor5/admin/src/config

  3. Set up extensions/ckeditor5/admin/src/config/ckeditor.js (see CKEditor configuration guide)

  4. Rebuild Strapi

npm run strapi build

Configuration example

// ckeditor.js
module.exports = ({
	// Override toolbar config to leave a few buttons
    toolbar: {
		items: [
			'heading',
			'|',
			'bold',
			'italic',
			'link',
			'alignment',
			'|',
			'undo',
			'redo'
		]
	}
});

Default configuration

For information and inspiration: default editor configuration defined here.

How to add more features to the editor

If you want to see more features in this plugin feel free to request it in issues or create pull request in the ckeditor-build-strapi-wysiwyg repo. Together we will build a comprehensive editor for common needs.

Acknowledgement

This plugin uses some code from official manual.

Links

โญ๏ธ Show your support

Give a star if this project helped you.

strapi-plugin-ckeditor-markdown's People

Contributors

adilamanat avatar

Watchers

James Cloos 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.