Guide 2 for Craft CMS 3

Craft CMS is intuitive. Marketing plans and organizational workflows—not so much. Guide lets you create a user manual within Craft CMS so clients don‘t need to go far to get the answers they need.

Guide is made up of two parts:

• The commercial plugin for Craft 3
• The open source user guide template

Note: The license fee for the PRO edition this plugin is $49 via the Craft Plugin Store. A LITE edition is offered for free.

Requirements

• This plugin requires Craft CMS 3.5 or later.
• A browser that support CSS Grid Layout and CSS Custom Properties.

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 new Template Path and Asset Path settings are required for guides to be displayed.
2. Create your CMS guide using the built-in editor, by importing guides from Craft Guide Templates, or by selecting templates added to your Guide Template Path.
3. Use the Organizer to place your guides in the Guide CP section, on content edit pages, and on dashboard widgets.
4. Use Guide’s Rebrand settings page to style the look and feel of guides throughout the CMS.

Documentation

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

Brought to you by Will Browar