@netresearch/ckeditor-cowriter
v1.0.1
Published
Use AI to help you writing with CKEditor 4
Downloads
57
Readme
CKEditor 4 Plugin - Cowriter 🤖
This plugin generates content with the help of artificial intelligence. It is based on the CKEditor 4. It uses the OpenAI API to generate text. You can use it to generate text for your blog posts, emails, or any other content.
Give it a try and let the AI write for you: Demo
Installation
You can find the plugin in the CKEditor plugin directory
Installation with npm
Install the plugin with npm:
npm install @netresearch/ckeditor-cowriter --save
Enable the plugin by using the
extraPlugins
configuration setting. For example:CKEDITOR.plugins.addExternal('cowriter', '/node_modules/@netresearch/ckeditor-cowriter/dist/', 'plugin.js') CKEDITOR.config.extraPlugins = 'cowriter';
Installation from source
Download the latest release of the plugin.
Extract the contents of the archive into a directory. For example:
/plugins/cowriter/
Enable the plugin by using the
addExternal
andextraPlugins
configuration setting. For example:CKEDITOR.plugins.addExternal('cowriter', '/plugins/cowriter/', 'plugin.js') CKEDITOR.config.extraPlugins = 'cowriter';
Configuration
You need to define your OpenAI credentials. Do this above the CKEDITOR.replace
call. For example:
const OPENAI_KEY = 'YOUR-KEY'
const OPENAI_ORG = 'org-YOUR-ORG-KEY'
Usage
- Click on the
Cowriter
button in the toolbar. - Enter a prompt.
- Click on the
Generate
button. - The generated text will be inserted into the editor.
License
Licensed under the terms of the GNU General Public License, version 3 or later.
Credits
- All Contributors
- This plugin is based on the CKEditor 4 Plugin - GPT-3 by Netresearch.
- It uses Flaticon's document icon.
Contributing
We welcome contributions to this project. Please see our contribution guidelines for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker!
Contact
Netresearch, the company behind this plugin, is a leading European provider of digital solutions and services for the eCommerce industry. We are a team of eCommerce experts, developers, designers, project managers, and consultants. We are passionate about eCommerce and we love to share our knowledge with the community.