Welcome to the AI Smart Suggestions Plugin repository. This WordPress plugin leverages AI capabilities to provide intelligent text suggestions for headings and paragraphs in the Gutenberg editor. At the moment Groq is the only AI provider supported by this plugin. The plugin aims to enhance writing quality and assist users in creating engaging content efficiently.
- Writing Assistance: Provides suggestions to improve grammar, style, and readability.
- Content Enrichment: Suggests engaging content based on the user's writing style and preferences.
- User-Friendly Interface: Seamlessly integrates with the Gutenberg editor.
- Refreshed Suggestions: Users can refresh and get new suggestions for their writing.
Before you begin, ensure you have met the following requirements:
- WordPress 6.2 or higher
- PHP 7.4 or higher
- Node.js 18.12.0 or higher
- You have installed Docker and added support for Docker Compose commands. Instructions are available here.
- You have installed GNU Make utility, which is commonly used to automate the build process of software projects. Make is often pre-installed if you're using a Unix-like system (such as Linux or macOS). Run this command to verify the installation: make --version
- Clone the repository to your local WordPress plugins directory:
git clone https://github.com/hasukmistry/ai-smart-suggestions.git wp-content/plugins/ai-smart-suggestions- Run the following commands to install the plugin and its dependencies:
composer install --no-dev --optimize-autoloader
composer dump-autoload -o- Run the following command to install the required npm dependencies:
npm install- Run the following command to build the plugin:
npm run build-
Navigate to the WordPress dashboard, go to the 'Plugins' section, and activate the AI Smart Suggestions Plugin.
-
Navigate to the WordPress dashboard, go to the 'Settings' section, and click on the 'Smart Suggestions'. Configure your Groq API key and other settings as needed. Get up and running with AI Smart Suggestions!
- Activate the Plugin: Ensure the plugin is activated from the WordPress plugins dashboard.
- Create or Edit a Post: Open the Gutenberg editor by creating a new post or editing an existing one.
- Receive Suggestions: Start typing in a heading or paragraph block. New icon will appear on the block toolbar to show the Smart Suggestions.
- Smart Suggestions: Click on the Smart Suggestions icon, It will show a modal with suggestions for the current text. You can choose the suggested text and apply it to the block. Or you can click on the 'Refresh' button to get new suggestions.
Navigate to the plugin settings page under 'Settings > Smart Suggestions' to configure:
- AI Provider: Select the AI provider you want to use. Currently, only Groq is supported.
- AI Model: Select the AI model you want to use. Groq offers several models, such as 'LLaMA3 8b', 'LLaMA3 70b', 'Mixtral 8x7b', and 'Gemma 7b'.
- API Key: Enter your Groq API key.
- v1.0: Initial release with Groq as the only AI provider. Suggestions are provided for headings and paragraphs.
Contributions are welcomed from the community! To contribute:
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch). - Make your changes and commit them (
git commit -m 'Add new feature'). - Push to the branch (
git push origin feature-branch). - Create a new Pull Request.
Please ensure all changes adhere to the project's coding standards. Use the following commands to run the linter:
npm run lint:js
composer phpcs
This project is licensed under the GNU General Public License version 3. See the LICENSE file for details.
For any questions or inquiries, please contact:
- Name: Hasmukh K Mistry
- LinkedIn: hasmukh-k-mistry
- X: hasukmistry
- Threads @el.happinio
Thank you for using the AI Smart Suggestions Plugin!