https://github.com/samhammerag/hd-ckeditor5-classic

customized implementation of ckeditor5 classic build
https://github.com/samhammerag/hd-ckeditor5-classic

ckeditor5

Last synced: 23 days ago
JSON representation

customized implementation of ckeditor5 classic build

• Host: GitHub
• URL: https://github.com/samhammerag/hd-ckeditor5-classic
• Owner: SamhammerAG
• License: other
• Created: 2021-02-11T10:35:17.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2023-04-17T20:46:52.000Z (over 1 year ago)
• Last Synced: 2024-11-16T22:33:11.877Z (about 1 month ago)
• Topics: ckeditor5
• Language: HTML
• Homepage: https://www.ckeditor.com
• Size: 504 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
CKEditor 5 classic editor build

========================================

[![npm version](https://badge.fury.io/js/%40samhammer%2Fhd-ckeditor5-build-classic.svg)](https://www.npmjs.com/package/@samhammer/hd-ckeditor5-build-classic)

The classic editor build for HD.

## Installation

First, install the build from npm:

```bash

npm install --save @samhammer/hd-ckeditor5-build-classic

```

And use it in your website:

```html



	
This is the editor content.



	ClassicEditor

		.create( document.querySelector( '#editor' ) )

		.then( editor => {

			window.editor = editor;

		} )

		.catch( error => {

			console.error( 'There was a problem initializing the editor.', error );

		} );

```

Or in your JavaScript application:

```js

import ClassicEditor from '@samhammer/hd-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 );

	} );

```

## Local development

To test your changes to this build locally with the application you can use [npm link](https://docs.npmjs.com/cli/link).

## Publish new version

1. Apply all changes to the source files.

2. Run `npm run build`.

3. The compiled files are located in the "build" folder now.

4. Raise the version-number in package.json.

5. Commit all changes and create a git tag with the specific version number.

6. Run `npm publish --access public` to publish the compiled source as new package version to npm. This step can only be done from a member of the "Samhammer" npm Org.

7. Install the new package version in the application as dependency.

## 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.