ckeditor/ckeditor5-autoformat

View on GitHub
docs/api/autoformat.md

Summary

Maintainability
Test Coverage
---
category: api-reference
---

# CKEditor 5 autoformat feature

[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-autoformat.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-autoformat)

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

## Demo

Check out the demo in the {@link features/autoformat Autoformat feature} guide.

## Documentation

See the {@link features/autoformat Autoformat feature} guide and the {@link module:autoformat/autoformat~Autoformat} plugin documentation.

## Installation

```bash
npm install --save @ckeditor/ckeditor5-autoformat
```

## Contribute

The source code of this package is available on GitHub in https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-autoformat.

## External links

* [`@ckeditor/ckeditor5-autoformat` on npm](https://www.npmjs.com/package/@ckeditor/ckeditor5-autoformat)
* [`ckeditor/ckeditor5-autoformat` on GitHub](https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-autoformat)
* [Issue tracker](https://github.com/ckeditor/ckeditor5/issues)
* [Changelog](https://github.com/ckeditor/ckeditor5-autoformat/blob/master/CHANGELOG.md)