Guide is the CMS user manual in the CMS. In addition to a CMS Guide section, Guide makes it easy to create Control Panel pages, widgets, UI elements, expanded field instructions, and slideout pages without writing PHP.
Create a CMS user manual to give your clients an overview of the different part that make up their unique content setup. When more than one guide are shown together a navigation appears on the right.
Create, edit, and delete Guide content (aka guides) from one page. Here you can also manage which guides appear in the CMS Guide pagee.
Write guides using Markdown, HTML, and Twig. Guide PRO includes components and snippets to make writing even easier.
Any user in your Craft CMS site can be given permission to create and edit guides. This lets the whole team contribute in writing documentation.
CSS Editor PRO
Write CSS to design your guide with a unique layout. Use CSS to adjust the Control Panel when inserting guides into CSS selectors.
Use JavaScript to give your guide more functionality. NOTE: The JavaScript editor is disabled by default and enabled with plugin settings.
Guide Pages PRO
Every guide gets their own Control Panel page that can be linked to from field instructions, widgets, and other guides. Guide’s Twig features let you show different content for the same guide, based on whether or not it’s displayed as a widget, slidout, or on a full Guide Page.
Organizer PRO
Add guides to various places around the Craft CMS Control Panel. Use one of the sections in the Organizer or add guides to multiple pages using URI patterns.
UI Elements PRO
Put guides amongst your fields to provide extra instructions or to preview rendered content.
Add guides to edit pages to provide authoring instructions and to document business rules. Guides can appear in a slideout so they can be referred to and then dismissed, so your clients can go right back to creating content.
Guides can be added to any page in the Control Panel so you can provide instructions on plugin pages, utility pages, or global elements across the Control Panel.
Share guides from one Craft CMS project to another. Guide includes Twig variables that let you set things like the site name or client name in Guide plugin settings—making it easy to import templates without worrying that another client is mentioned.
Reduce Plugins and Custom Modules
A guide can be an HTML element, a documentation page, or anything else you can build with Twig in Craft CMS. Guides can display reports that calculate Commerce sales, track content authoring issues (missing fields, incorrect field combinations), and show which images are used on which page. As long as you can access data through Twig, you can create widgets and pages that provide powerful insights based on your business needs.
If you think you need to write a custom PHP module or to use a third-party plugin, see if Guide can help you achieve your goals.