PHPackages hillholliday/craft-user-manual - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. hillholliday/craft-user-manual ActiveCraft-plugin[Utility & Helpers](/categories/utility) hillholliday/craft-user-manual ============================== 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. 5.0.4(1y ago)8472.1k↓50%15[2 PRs](https://github.com/RobErskine/Craft-User-Manual/pulls)1MITPHPPHP ^8.0.2CI failing Since Sep 4Pushed 2mo ago3 watchersCompare [ Source](https://github.com/RobErskine/Craft-User-Manual)[ Packagist](https://packagist.org/packages/hillholliday/craft-user-manual)[ GitHub Sponsors](https://github.com/roberskine)[ RSS](/packages/hillholliday-craft-user-manual/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (10)Dependencies (2)Versions (17)Used By (1) Craft User Manual plugin for Craft CMS 4.x and Craft CMS 5.x ============================================================ [](#craft-user-manual-plugin-for-craft-cms-4x-and-craft-cms-5x) 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. [![Screenshot](resources/img/screenshot.jpg)](resources/img/screenshot.jpg) Requirements ------------ [](#requirements) This plugin requires Craft CMS 4.0.0 or later; or Craft CMS 5.0.0 or later. Installation ------------ [](#installation) ### Craft 4 and Craft 5 [](#craft-4-and-craft-5) To install the plugin in your Craft 4 or Craft 5 project, 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 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](https://packagist.org/packages/hillholliday/craft-user-manual) we have kept it as hillholliday. 3. In the Control Panel, go to Settings → Plugins and click the “Install” button for usermanual. 4. Select the section the plugin should use as the **User Manual** page in the CP. - (Optional) - Replace the plugin's name to something your user's will understand. - (Optional) - Use more than the default `body` fieldhandle by setting up custom template overrides. 5. Click the **User Manual** link in the CP nav. ### Craft 3 [](#craft-3) To install the plugin in your Craft 3 project, 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 hillholliday/craft-user-manual:2.1.2 ``` 3. In the Control Panel, go to Settings → Plugins and click the “Install” button for usermanual. 4. Select the section the plugin should use as the **User Manual** page in the CP. - (Optional) - Replace the plugin's name to something your user's will understand. - (Optional) - Use more than the default `body` fieldhandle by setting up custom template overrides. 5. Click the **User Manual** link in the CP nav. Configuration ------------- [](#configuration) - All settings may be optionally configured using a [config file](https://craftcms.com/docs/5.x/extend/plugin-settings.html#overriding-setting-values). The values, contained in [`config.php`](https://github.com/roberskine/Craft-User-Manual/blob/master/src/config.php), are described below: ### pluginNameOverride [](#pluginnameoverride) Intuitive, human-readable plugin name for the end user. ### templateOverride [](#templateoverride) For more control over the output, you may optionally override the default template. Path is relative to ../craft/templates/. ### section [](#section) Entries in this section must have associated urls. When this value is set from the `usermanua.php` file, it much use the section ID as the value, not the section handle. ### enabledSideBar [](#enabledsidebar) Enables the sidebar on the manual page Defaults to true. Some notes ---------- [](#some-notes) - The plugin currently only pulls in the `body` field from each entry in the selected section, unless you're using a template override. - While the **User Manual** section works best with `Structures`, you can certainly get away with using a one-off `Single`. - If you're running *Craft Client* or *Craft Pro* make sure your content editors don't have permission to edit whatever section you've selected to use as your **User Manual** - Only sections with entry URLs may be used as your **User Manual** section. Thanks ------ [](#thanks) This plugin was inspired by the team over at [70kft](http://70kft.com/) for their work on [Craft-Help](https://github.com/70kft/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. Releases -------- [](#releases) See CHANGELOG.md for full release history. - **5.0.4** - Adding in ability to customize URL segment of the user manual documentation section - **5.0.3** - Merging PRs from [JorgeAnzola](https://github.com/JorgeAnzola) to remove requirement for User Manual entries to require URLs - **5.0.2** - Replacing `addExtension` with Craft Hook - **5.0.1** - Required "section" config setting to be an integer. Added "enabledSideBar" config setting to enable/disable the sidebar on the manual page. This fix is to help address possible issue in Craft 4 to Craft 5 migration. - **5.0.0** - Craft 5 support! Thanks to [John Morton](https://github.com/johnfmorton) and [Dalton Rooney](daltonrooney) for your contributions. - **4.0.0** - Craft 4 support! Thanks to [Chris DuCharme](https://github.com/Chris-DuCharme) for migrating up to Craft 4. - **2.1.0** - Merging PRs from [JorgeAnzola](https://github.com/JorgeAnzola) and [sameerast](https://github.com/sameerast) - **2.0.3** - Forcing updating to plugin store - **2.0.2** - Merging in [@aaronbushnell](https://github.com/aaronbushnell)'s [fix for incorrect reference to asset bundle](https://github.com/roberskine/Craft-User-Manual/pull/17). - **2.0.1** - Merging in [@mgburns](https://github.com/mgburns)' [fix for Craft 3 deprecation warnings](https://github.com/roberskine/Craft-User-Manual/pull/11). - **2.0.0** - Merging in [@jcdarwin](https://github.com/jcdarwin) Craft 3 port. [Craft 3 version of Craft User Manual](https://github.com/roberskine/Craft-User-Manual/pull/8). - **1.1.1** - Adding in RTL language support. - **1.1.0** - Merging in [@timkelty](https://github.com/timkelty)'s work which [includes template overrides, updated error prompts, and other misc improvements](https://github.com/roberskine/Craft-User-Manual/pull/3). - **1.0.1** - Adding support for plugin custom icons in Craft 2.5. - **1.0.0** - Initital release of Craft User Manual. We hope this plugin is useful, and we'd love to hear any suggestions or issues you may have. [@erskinerob](https://twitter.com/erskinerob). Brought to you by [Rob Erskine](https://twitter.com/erskinerob). ### Health Score 55 — FairBetter than 98% of packages Maintenance66 Regular maintenance activity Popularity43 Moderate usage in the ecosystem Community22 Small or concentrated contributor base Maturity75 Established project with proven stability Bus Factor1 Top contributor holds 59.3% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~195 days Recently: every ~74 days Total 13 Last Release 461d ago Major Versions 2.1.2 → 4.0.02022-06-20 4.0.0 → 5.0.02024-04-15 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/1895120?v=4)[Rob Erskine](/maintainers/RobErskine)[@RobErskine](https://github.com/RobErskine) --- Top Contributors [![RobErskine](https://avatars.githubusercontent.com/u/1895120?v=4)](https://github.com/RobErskine "RobErskine (64 commits)")[![johnfmorton](https://avatars.githubusercontent.com/u/119723?v=4)](https://github.com/johnfmorton "johnfmorton (32 commits)")[![mgburns](https://avatars.githubusercontent.com/u/1508604?v=4)](https://github.com/mgburns "mgburns (3 commits)")[![sameerast](https://avatars.githubusercontent.com/u/2019441?v=4)](https://github.com/sameerast "sameerast (3 commits)")[![JorgeAnzola](https://avatars.githubusercontent.com/u/15676614?v=4)](https://github.com/JorgeAnzola "JorgeAnzola (3 commits)")[![mcclaskiem](https://avatars.githubusercontent.com/u/6970287?v=4)](https://github.com/mcclaskiem "mcclaskiem (1 commits)")[![brandonkelly](https://avatars.githubusercontent.com/u/47792?v=4)](https://github.com/brandonkelly "brandonkelly (1 commits)")[![aaronbushnell](https://avatars.githubusercontent.com/u/315202?v=4)](https://github.com/aaronbushnell "aaronbushnell (1 commits)") --- Tags craft-plugincraftcmscraftcms-pluginusefulcmsCraftcraftcmscraft-pluginusermanual ### Embed Badge ![Health badge](/badges/hillholliday-craft-user-manual/health.svg) ``` [![Health](https://phpackages.com/badges/hillholliday-craft-user-manual/health.svg)](https://phpackages.com/packages/hillholliday-craft-user-manual) ``` ### Alternatives [verbb/navigation Create navigation menus for your site. 90683.7k17](/packages/verbb-navigation)[verbb/formie The most user-friendly forms plugin for Craft. 101372.9k40](/packages/verbb-formie)[verbb/comments Add comments to your site. 13753.1k](/packages/verbb-comments)[verbb/tablemaker Create customizable and user-defined table fields. 40168.8k1](/packages/verbb-tablemaker)[supercool/tablemaker Create customizable and user-defined table fields. 40141.7k](/packages/supercool-tablemaker)[verbb/vizy A flexible visual editor field for Craft. 4348.6k](/packages/verbb-vizy) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)