@ckeditor/ckeditor5-merge-fields/README.md

Merge fields feature for CKEditor 5.

CKEditor 5 Merge fields feature
====================================

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

This package implements the merge fields feature for CKEditor 5. It allows you to create distinct, named "placeholder" elements in the content that can be later on easily replaced by actual data.

This feature is useful for creating document templates, as well as making sure that some specific, configured values stay consistent and up-to-date throughout the whole document.

This is a premium feature. Sign up for a [free non-commitment 14-day trial](https://portal.ckeditor.com/checkout?plan=free), or see: [https://ckeditor.com/pricing](https://ckeditor.com/pricing) for more information.

## Installation

This plugin is part of the `ckeditor5-premium-features` package. Install the whole package to use it.

```bash
npm install ckeditor5-premium-features
```

## Create free account

If you want to check full CKEditor 5 capabilities, sign up for a [free non-commitment 14-day trial](https://portal.ckeditor.com/checkout?plan=free).

## Demo

Check out the [demo in the Merge fields](https://ckeditor.com/docs/ckeditor5/latest/features/merge-fields.html#demo) feature guide.

## Documentation

See the [`@ckeditor/ckeditor5-merge-fields` package](https://ckeditor.com/docs/ckeditor5/latest/api/merge-fields.html) page in [CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/) as well as the [Merge fields](https://ckeditor.com/docs/ckeditor5/latest/features/merge-fields.html) feature guide.

## Getting support

The CKEditor 5 Merge fields feature comes with outstanding support from a dedicated team of customer care specialists, QA engineers, and CKEditor 5 developers. The team will gladly assist you in all aspects from setting up your account to integrating the CKEditor 5 Merge fields feature with your application.

As a licensed CKEditor 5 Merge fields feature user you can report bugs and request features directly through the CKEditor Ecosystem customer dashboard.

## License

**CKEditor&nbsp;5 Merge fields feature** (https://ckeditor.com/ckeditor-5/)<br>
Copyright (c) 2003–2025, [CKSource Holding sp. z o.o.](https://cksource.com)  All rights reserved.

CKEditor&nbsp;5 Merge fields feature is licensed under a commercial license and is protected by copyright law. For more information, see: [https://ckeditor.com/pricing](https://ckeditor.com/pricing).

### Trademarks

**CKEditor** is a trademark of [CKSource Holding sp. z o.o.](https://cksource.com)  All other brand and product names are trademarks, registered trademarks or service marks of their respective holders.