README

Guido is a Craft CMS plugin that lets you create and manage in-panel guides directly inside the Craft control panel. It’s built to help agencies and developers provide clear documentation, onboarding instructions, and editor handbooks right where clients and team members need them.

Write guides in Markdown, embed images or links with simple syntax, take advantage of the built-in search functionality, and even export/import guides for easy re-use across projects. With Guido, you can ship websites to clients with pre-made guides included—making training and support smoother.

Features

• Guides in Markdown: Write documentation in plain Markdown with support for headings, lists, links, and inline formatting.
• Image Embeds: Link and display images directly in your guides with Markdown syntax.
• Admin Menu Integration: Accessible from the main control panel menu for quick reference.
• Export/Import Articles: Reuse and transfer guides between projects effortlessly.
• Search Functionality: Quickly find guides across all categories.
• Perfect for Clients & Teams: Provide onboarding docs, editor instructions, and custom workflows without leaving the CMS.

Requirements

• Craft CMS 5.0.0 or later
• PHP 8.2+

Installation

You can install this plugin from the Plugin Store or with Composer.

From the Plugin Store

Go to the Plugin Store in your project’s Control Panel and search for “Guido”. Then click on the “Install” button in its modal window.

With Composer

# go to the project directory
cd /path/to/my-project.test

# tell Composer to load the plugin
composer require convergine/craft-guido

# tell Craft to install the plugin
./craft plugin/install guido

Roadmap

• Organize by Categories: Group related articles under categories for easier navigation.

Support

For any issues or questions, you can reach us by email info@convergine.com or by opening an issue on GitHub.