README

This recipe provides a seamless integration of AI-powered writing assistance directly within the CKEditor 5 toolbar for Drupal. It automates the installation and configuration of the AI CKEditor module, giving content creators tools for text generation, summarization, and formatting.

🚀 Overview

The AI CKEditor recipe enhances the standard editing experience by allowing users to interact with Large Language Models (LLMs) without leaving the content creation interface. It supports leading providers like OpenAI and Anthropic via the core AI module.

🛠 Requirements

Before installing this recipe, ensure the following:

• AI Module: Must be installed and configured.
• API Key: A valid API key from a supported provider (OpenAI, Anthropic, etc.) must be created and select at /admin/config/ai/providers for corresponding provider.
• Chat: A default provider and model must be selected for operation type "Chat" here /admin/config/ai/settings
• Content Format: Make sure that format named "Content" with machine name content_format exists here /admin/config/content/formats. This format is usually installed with Drupal CMS recipe "Content Basics".

📦 What's Included?

Modules Installed

• ai_ckeditor

Automatic Configuration

• Toolbar Integration: The AI button is automatically added to the "Content" text format.
• Permissions: The Content Editor role is granted the use ai ckeditor permission.

✨ Features

Enabled by Default

• Text Completion: Generate new content based on a text prompt.
• Summarize: Instantly create summaries of highlighted text.
• Reformat HTML: Clean up messy HTML tags and restructure code for consistency.

Optional Features

These can be enabled via Configuration > Content Authoring > Text formats and editors:

• Spellfix: Advanced AI grammar and spelling correction.
• Tone Adjustment: Change writing style (e.g., to Professional, Casual, or Concise).
• Translation: Multi-language content translation.
• Modify Prompt: Use custom instructions to transform selected text.

🔧 Installation & Post-Setup

1. Apply the Recipe: Run the recipe via your preferred method (e.g., Composer or the Drupal UI).
2. Configure Provider: Visit /admin/config/ai/settings to ensure your AI model is active.
3. Editor Setup: To toggle specific AI tools, edit the "Content" format at /admin/config/content/formats.

📄 License

This project is licensed under the same terms as Drupal core (GPLv2 or later).