wbrowar / craft-guide

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.

Guide 3 for Craft CMS 4

Requirements

• This plugin requires Craft CMS 4.0 or later.

Installation

To install the plugin, you can find it in the Craft Plugin Store, or follow these instructions.

1. Open your terminal and go to your Craft project:

   cd /path/to/project
   

2. Then tell Composer to load the plugin:

   composer require wbrowar/guide
   

3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Guide.

Setup

1. Visit the Guide settings page to configure a couple of setup options. The 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.
2. Create your guides using the built-in editor or by selecting templates added to your Guide Template Path.
3. Use the Organizer to place your guides around the Craft CMS Control Panel.

Documentation

Documenation for Guide and Craft Guide Templates can be found here.

Brought to you by Will Browar

Here are some great open source projects that were used to help create this plugin:

• Nuxt.js
• Tailwind CSS
• Vite.js
• Vue.js

Thanks to the maintainers for doing what you do to make things like this possible. 💚