title: Autoformatting
The {@link module:autoformat/autoformat~Autoformat} feature allows you to quickly apply formatting to the content you are writing.
This feature is enabled by default in all builds.
The following block formatting options are available:
* or - followed by a space.1. or 1) followed by a space.# or ## or ### followed by a space to create a heading 1, heading 2 or heading 3 (up to heading 6 if {@link module:heading/heading~HeadingConfig#options} defines more headings).> followed by a space.The following inline formatting options are available:
**text** or __text__,*text* or _text_,`text`,~~text~~.Example:
{@snippet features/autoformat}
In addition to enabling automatic text formatting, you may want to check the following productivity features:
(tm) into ™ and "foo" into “foo”.
This feature is enabled by default in all builds. The installation instructions are for developers interested in building their own, custom editor.
To add this feature to your editor install the @ckeditor/ckeditor5-autoformat package:
npm install --save @ckeditor/ckeditor5-autoformat
And add it to your plugin list:
import Autoformat from '@ckeditor/ckeditor5-autoformat/src/autoformat';
ClassicEditor
.create( document.querySelector( '#editor' ), {
plugins: [ Autoformat, ... ],
toolbar: [ ... ]
} )
.then( ... )
.catch( ... );
Remember to add proper features to the editor configuration. Autoformatting will be enabled only for the commands that are included in the actual configuration. For example: `bold` autoformatting will not work if there is no `bold` command registered in the editor.
Read more about {@link builds/guides/integration/installing-plugins installing plugins}.
The {@link module:autoformat/autoformat~Autoformat} feature bases on {@link module:autoformat/blockautoformatediting~blockAutoformatEditing} and {@link module:autoformat/inlineautoformatediting~inlineAutoformatEditing} tools to create the autoformatters mentioned above.
You can use these tools to create your own autoformatters. Check the Autoformat feature's code as an example.
The source code of the feature is available on GitHub in https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-autoformat.