# ck5-build-custom

> The classic editor build of CKEditor 5 – the best browser-based rich text editor.

Latest version **1.0.0** (published 2023-10-08) · GPL-2.0-or-later license · 0 weekly downloads

## Install

```sh
npm install ck5-build-custom
pnpm add ck5-build-custom
yarn add ck5-build-custom
bun add ck5-build-custom
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-10-08 |
| First published | 2023-10-08 |
| Weekly downloads | 0 |
| License | GPL-2.0-or-later |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 26 |
| Unpacked size | 7.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10495 |
| Author | Jane |
| Maintainers | cct124 |
| Keywords | ckeditor5-build, ckeditor, ckeditor5, ckeditor 5, wysiwyg, rich text, editor, html, contentEditable, editing, operational transformation, ot, collaboration, collaborative, real-time, framework |

## Links

- npm: https://www.npmjs.com/package/ck5-build-custom
- Repository: https://github.com/ckeditor/ckeditor5
- Homepage: https://ckeditor.com/ckeditor-5
- Issues: https://github.com/ckeditor/ckeditor5/issues
- npm.io page: https://npm.io/package/ck5-build-custom

## Dependencies (26)

- [@ckeditor/ckeditor5-font](https://npm.io/package/@ckeditor/ckeditor5-font.md) ^39.0.2
- [@ckeditor/ckeditor5-link](https://npm.io/package/@ckeditor/ckeditor5-link.md) 39.0.2
- [@ckeditor/ckeditor5-list](https://npm.io/package/@ckeditor/ckeditor5-list.md) 39.0.2
- [@ckeditor/ckeditor5-ckbox](https://npm.io/package/@ckeditor/ckeditor5-ckbox.md) 39.0.2
- [@ckeditor/ckeditor5-image](https://npm.io/package/@ckeditor/ckeditor5-image.md) 39.0.2
- [@ckeditor/ckeditor5-table](https://npm.io/package/@ckeditor/ckeditor5-table.md) 39.0.2
- [@ckeditor/ckeditor5-indent](https://npm.io/package/@ckeditor/ckeditor5-indent.md) ^39.0.2
- [@ckeditor/ckeditor5-typing](https://npm.io/package/@ckeditor/ckeditor5-typing.md) 39.0.2
- [@ckeditor/ckeditor5-heading](https://npm.io/package/@ckeditor/ckeditor5-heading.md) 39.0.2
- [@ckeditor/ckeditor5-ckfinder](https://npm.io/package/@ckeditor/ckeditor5-ckfinder.md) 39.0.2
- [@ckeditor/ckeditor5-alignment](https://npm.io/package/@ckeditor/ckeditor5-alignment.md) ^39.0.2
- [@ckeditor/ckeditor5-paragraph](https://npm.io/package/@ckeditor/ckeditor5-paragraph.md) 39.0.2
- [@ckeditor/ckeditor5-autoformat](https://npm.io/package/@ckeditor/ckeditor5-autoformat.md) 39.0.2
- [@ckeditor/ckeditor5-easy-image](https://npm.io/package/@ckeditor/ckeditor5-easy-image.md) 39.0.2
- [@ckeditor/ckeditor5-essentials](https://npm.io/package/@ckeditor/ckeditor5-essentials.md) 39.0.2
- [@ckeditor/ckeditor5-block-quote](https://npm.io/package/@ckeditor/ckeditor5-block-quote.md) 39.0.2
- [@ckeditor/ckeditor5-export-word](https://npm.io/package/@ckeditor/ckeditor5-export-word.md) ^39.0.2
- [@ckeditor/ckeditor5-import-word](https://npm.io/package/@ckeditor/ckeditor5-import-word.md) ^39.0.2
- [@ckeditor/ckeditor5-media-embed](https://npm.io/package/@ckeditor/ckeditor5-media-embed.md) 39.0.2
- [@ckeditor/ckeditor5-basic-styles](https://npm.io/package/@ckeditor/ckeditor5-basic-styles.md) 39.0.2
- [@ckeditor/ckeditor5-cloud-services](https://npm.io/package/@ckeditor/ckeditor5-cloud-services.md) 39.0.2
- [@ckeditor/ckeditor5-editor-classic](https://npm.io/package/@ckeditor/ckeditor5-editor-classic.md) 39.0.2
- [@ckeditor/ckeditor5-source-editing](https://npm.io/package/@ckeditor/ckeditor5-source-editing.md) ^39.0.2
- [@ckeditor/ckeditor5-adapter-ckfinder](https://npm.io/package/@ckeditor/ckeditor5-adapter-ckfinder.md) 39.0.2
- [@ckeditor/ckeditor5-find-and-replace](https://npm.io/package/@ckeditor/ckeditor5-find-and-replace.md) ^39.0.2
- [@ckeditor/ckeditor5-paste-from-office](https://npm.io/package/@ckeditor/ckeditor5-paste-from-office.md) 39.0.2

## Alternatives

- [ext-list](https://npm.io/package/ext-list.md) — 6.3M weekly downloads
- [@lexical/selection](https://npm.io/package/@lexical/selection.md) — 3.8M weekly downloads
- [@lexical/text](https://npm.io/package/@lexical/text.md) — 3.6M weekly downloads
- [@lexical/clipboard](https://npm.io/package/@lexical/clipboard.md) — 3.0M weekly downloads
- [@tiptap/extension-mention](https://npm.io/package/@tiptap/extension-mention.md) — 3.0M weekly downloads

## Recent versions

- 1.0.0 (latest) — 2023-10-08

## README

CKEditor 5 classic editor build
========================================

[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-build-classic.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-build-classic)
[![Coverage Status](https://coveralls.io/repos/github/ckeditor/ckeditor5/badge.svg?branch=master)](https://coveralls.io/github/ckeditor/ckeditor5?branch=master)
[![Build Status](https://travis-ci.com/ckeditor/ckeditor5.svg?branch=master)](https://app.travis-ci.com/github/ckeditor/ckeditor5)

The classic editor build for CKEditor 5. Read more about the [classic editor build](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/predefined-builds.html#classic-editor) and see the [demo](https://ckeditor.com/docs/ckeditor5/latest/examples/builds/classic-editor.html).

![CKEditor 5 classic editor build screenshot](https://c.cksource.com/a/1/img/npm/ckeditor5-build-classic.png)

## Documentation

See:

* [Installation](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/quick-start.html) for how to install this package and what it contains.
* [Editor lifecycle](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/editor-lifecycle.html) for how to create an editor and interact with it.
* [Configuration](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/configuration.html) for how to configure the editor.
* [Creating custom builds](https://ckeditor.com/docs/ckeditor5/latest/installation/getting-started/quick-start.html#building-the-editor-from-source) for how to customize the build (configure and rebuild the editor bundle).

## Quick start

First, install the build from npm:

```bash
npm install --save @ckeditor/ckeditor5-build-classic
```

And use it in your website:

```html
<div id="editor">
	<p>This is the editor content.</p>
</div>
<script src="./node_modules/@ckeditor/ckeditor5-build-classic/build/ckeditor.js"></script>
<script>
	ClassicEditor
		.create( document.querySelector( '#editor' ) )
		.then( editor => {
			window.editor = editor;
		} )
		.catch( error => {
			console.error( 'There was a problem initializing the editor.', error );
		} );
</script>
```

Or in your JavaScript application:

```js
import ClassicEditor from '@ckeditor/ckeditor5-build-classic';

// Or using the CommonJS version:
// const ClassicEditor = require( '@ckeditor/ckeditor5-build-classic' );

ClassicEditor
	.create( document.querySelector( '#editor' ) )
	.then( editor => {
		window.editor = editor;
	} )
	.catch( error => {
		console.error( 'There was a problem initializing the editor.', error );
	} );
```

**Note:** If you are planning to integrate CKEditor&nbsp;5 deep into your application, it is actually more convenient and recommended to install and import the source modules directly (like it happens in `ckeditor.js`). Read more in the [Advanced setup guide](https://ckeditor.com/docs/ckeditor5/latest/installation/advanced/alternative-setups/integrating-from-source-webpack.html).

## License

Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html). For full details about the license, please check the `LICENSE.md` file or [https://ckeditor.com/legal/ckeditor-oss-license](https://ckeditor.com/legal/ckeditor-oss-license).

---
_Source: https://npm.io/package/ck5-build-custom · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._