@ckeditor/ckeditor5-autoformat

What is @ckeditor/ckeditor5-autoformat?

@ckeditor/ckeditor5-autoformat is a plugin for CKEditor 5 that allows for automatic formatting of text as you type. It provides a user-friendly way to apply formatting like bold, italic, and headings without needing to use toolbar buttons or keyboard shortcuts.

What are @ckeditor/ckeditor5-autoformat's main functionalities?

Bold Formatting

Automatically formats text to bold when surrounded by double asterisks (**bold**).

ClassicEditor.create(document.querySelector('#editor'), { plugins: [ Autoformat, Bold, Essentials, Paragraph ], toolbar: [ 'bold' ] });

Italic Formatting

Automatically formats text to italic when surrounded by single asterisks (*italic*).

ClassicEditor.create(document.querySelector('#editor'), { plugins: [ Autoformat, Italic, Essentials, Paragraph ], toolbar: [ 'italic' ] });

Heading Formatting

Automatically formats text to headings when prefixed with hash symbols (## Heading).

ClassicEditor.create(document.querySelector('#editor'), { plugins: [ Autoformat, Heading, Essentials, Paragraph ], toolbar: [ 'heading' ] });

Other packages similar to @ckeditor/ckeditor5-autoformat

quill

Quill is a modern WYSIWYG editor built for compatibility and extensibility. It offers similar autoformatting features through its modules and can be customized to provide automatic text formatting.

tinymce

TinyMCE is a popular rich text editor that provides a wide range of formatting options, including autoformatting through plugins. It is highly customizable and can be extended to include features similar to @ckeditor/ckeditor5-autoformat.

draft-js

Draft.js is a JavaScript rich text editor framework, built for React. It allows for extensive customization and can be configured to support autoformatting features similar to those provided by @ckeditor/ckeditor5-autoformat.

README

CKEditor 5 autoformat feature

This package implements the autoformatting feature for CKEditor 5. It allows styling text by typing sequences like **bold this**.

Installation

This plugin is part of the ckeditor5 package. Install the whole package to use it.

npm install ckeditor5

Create free account

If you want to check full CKEditor 5 capabilities, sign up for a free non-commitment 14-day trial.

Demo

Check out the demo in the autoformat feature guide.

Documentation

See the @ckeditor/ckeditor5-autoformat package page in CKEditor 5 documentation.

License

Licensed under a dual-license model, this software is available under:

• the GNU General Public License Version 2 or later,
• or commercial license terms from CKSource Holding sp. z o.o.

For more information, see: https://ckeditor.com/legal/ckeditor-licensing-options.