Guide

Guide is an author’s notebook and a developer’s best friend.

Content authors can create and manage their own CMS Guide, create pages in Craft CMS’s Control Panel, and manage their own content shown in widgets and slideout panels on entry edit pages.

Developers can use Guide instead of writing custom modules and site-specific plugins that provide reports, content-editing warnings, and tools that customize the author-experience around Craft CMS’s Control Panel.

Guide makes it easy to share helpful information all around the Craft CMS Control panel, so content authors don‘t need to go far to get the answers they need.

Guide content (AKA guides) can be written in Markdown or Twig using the built-in text editor. When using Twig you can use anything available in Craft CMS’s Twig tags, methods, and filters—and you can even use Twig code provided by other plugins.

The Guide Organizer shows you all of the guides in your CMS and makes it easy to add them around the Craft CMS Control Panel. Guides can appear on their own standalone pages, in slideouts, as widgets, and amongst editing fields in UI Elements. With a little CSS know-how you can even use Guide to add HTML elements to the Control Panel UI.

Mentions

Honcho’s Craft CMS Developer Benchmark (multiple editions)

Mentioned in Katie Fritz’s Dotall 2018 session, Prioritizing Author Experience

Mentioned in Kyle Cotter’s presentation at the May 2019 Happy Cog meetup, Crafting for the Author: Improving Author Experience (AX) with a Craft setup that you or your clients love to use

Editions

The PRO edition of Guide includes the Guide Organizer and a code editor with Twig components that make it easy to create guides and distribute them throughout the Craft CMS Control Panel (edit page slideouts, standalone CP pages, widgets, UI elements, and any CP URL you specify).

The LITE edition is offered for developers who prefer to write their own guide Twig templates in their favorite code editor and to display them on the CMS Guide page.

Guide’s edition can be upgraded to PRO at any time.