Guide authors around the Craft CMS Control Panel with pages, widgets, and Twig snippets.
Craft CMS is intuitive. Marketing plans and organizational workflows—not so much. Guide lets you create a user manual throughout Craft CMS so clients don‘t need to go far to get the answers they need.
Guide was built to be a CMS manual, but Guide 3 is also a quick way to create widgets and unique Craft CP pages, without the use of a custom module or knowledge of PHP.
To install the plugin, you can find it in the Craft Plugin Store, or follow these instructions.
Open your terminal and go to your Craft project:
cd /path/to/project
Then tell Composer to load the plugin:
composer require wbrowar/guide
In the Control Panel, go to Settings → Plugins and click the “Install” button for Guide.
Template Path
setting is required for guides to be displayed. The Asset Volume
setting is recommended when screenshots and other images are used in your guide content.Documenation for Guide and Craft Guide Templates can be found here.
Release notes can be found at CHANGELOG.md
Here is a general goal for adding and supporting features for Guide going forward:
Brought to you by Will Browar