๐ Help Section Plugin for Craft CMS.
Craft User Manual allows developers (or even content editors) to provide CMS documentation using Craft's built-in sections (singles, channels, or structures) to create a "User Manual" or "Help" section directly in the control panel.
This plugin requires Craft CMS 4.0.0 or later.
To install the plugin in your Craft 4 project, 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 hillholliday/craft-user-manual
Wondering why it says hillholliday and not roberskine as the org? This package was originally submitted as hillholliday, and to preserve the artifacts on Packagist we have kept it as hillholliday.
In the Control Panel, go to Settings โ Plugins and click the โInstallโ button for usermanual.
Select the section the plugin should use as the User Manual page in the CP.
body
fieldhandle by setting up custom template overrides.Click the User Manual link in the CP nav.
To install the plugin in your Craft 3 project, 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 hillholliday/craft-user-manual:2.1.2
In the Control Panel, go to Settings โ Plugins and click the โInstallโ button for usermanual.
Select the section the plugin should use as the User Manual page in the CP.
body
fieldhandle by setting up custom template overrides.Click the User Manual link in the CP nav.
config.php
, are described below:Intuitive, human-readable plugin name for the end user.
For more control over the output, you may optionally override the default template.
Path is relative to ../craft/templates/.
Entries in this section must have associated urls.
Enables the sidebar on the manual page
Defaults to true.
body
field from each entry in the selected section, unless you're using a template override.Structures
, you can certainly get away with using a one-off Single
.This plugin was inspired by the team over at 70kft for their work on Craft-Help. While their plugin is definitely more flexible in terms of writing custom markdown in separate files, we wanted to create something that would make it easier for anyone to edit documentation without making any changes to the server. This works particularly well for larger projects where more than one person (especially non-devs) are writing documentation for how to use the CMS.
We hope this plugin is useful, and we'd love to hear any suggestions or issues you may have. @erskinerob.
Brought to you by Rob Erskine.