Installation & Setup

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.
Edit this page on GitHub Updated at Wed, Aug 25, 2021