From an undocumented project to a working component guide — in under two minutes.
What you get
Drop a GUIDE.md into your blocks folder and every Twig template in it is listed — no config, no registration, no migration.
Your real templates, rendered with your site's own CSS, in an isolated frame. Switch viewports to check responsive behaviour.
One click drafts a story from the template's own variables — including one per state it switches on, like light and dark.
Wherever editors add a block — the entry editor or Live Preview — they browse real previews with descriptions and click the one they want. It lands prefilled, visible on the page straight away.
Write @lorem_p_2 or @image_1600x600 instead of pasting filler. Deterministic, so previews never flicker.
Stories are plain files next to your templates, in git. Remove the plugin and your project is exactly as it was.
Inside the control panel
Works with what you already have
There's no library folder to build and no components to move. Component Guide reads the templates where they already live — a marker file opts a folder in, a story file unlocks previews, and both sit in git next to the code they describe.
That also means leaving is free: uninstall the plugin and nothing in your content, your field layouts or your templates changes.
$39/year for updates after the first year. Free to trial in development and staging — you only pay when it goes to production.
- Craft CMS 5, PHP 8.2+
- One edition — every feature included
- Sold and licensed through the Craft Plugin Store
Questions, or something not working?
The plugin is built and supported by me — bug reports, feature ideas and “this felt weird” notes are all welcome.
Open an issue on GitHub