kirby-scaffold-page-type
Scaffolds a new Kirby page type (blueprint + template, optional controller/model) using project roots, index tools, and Panel field/section references. Use when creating a new page type or extending an existing blueprint/template.
When & Why to Use This Skill
The Kirby Scaffold Page Type skill is a specialized developer tool designed to automate the creation of page structures within the Kirby CMS ecosystem. By generating synchronized blueprints, templates, controllers, and models, it ensures that new page types adhere to project-specific naming conventions and architectural standards, significantly reducing manual boilerplate coding and configuration errors.
Use Cases
- Quickly scaffolding new custom page types with specific Panel fields and UI layouts to speed up Kirby CMS development.
- Extending existing blueprints and templates to maintain design consistency and code reuse across complex website structures.
- Setting up specialized content sections such as blogs, portfolios, or one-pager modules with pre-configured controllers and models.
- Ensuring technical compliance and preventing naming collisions by automatically validating file paths and class names against the project root.
| name | kirby-scaffold-page-type |
|---|---|
| description | Scaffolds a new Kirby page type (blueprint + template, optional controller/model) using project roots, index tools, and Panel field/section references. Use when creating a new page type or extending an existing blueprint/template. |
Kirby Scaffold Page Type
Quick start
- Follow the workflow below to scaffold a new page type safely.
KB entry points
kirby://kb/scenarios/01-scaffold-page-typekirby://kb/scenarios/22-custom-post-typeskirby://kb/scenarios/30-create-a-blog-sectionkirby://kb/scenarios/31-one-pager-site-sectionskirby://kb/scenarios/06-blueprints-reuse-extends
Required inputs
- Page type name and required fields.
- Panel UX expectations and any reuse/extends needs.
- Template/controller/model naming preferences.
Minimal scaffold
Blueprint:
title: Example
fields:
title:
type: text
Template:
<?php snippet('header') ?>
<?php snippet('footer') ?>
Default controller/model
Controller:
return function ($page) {
return ['page' => $page];
};
Model:
class ExamplePage extends Page
{
}
Naming checklist
- Template filename matches blueprint id.
- Controller filename matches template name.
- Model class name matches template name in StudlyCase.
Common pitfalls
- Mismatched template, blueprint, and controller names.
- Creating a Panel type without a matching blueprint.
Workflow
- Ask for page type name, required fields, Panel UX expectations, and whether to extend an existing type.
- Call
kirby:kirby_initand readkirby://rootsto locate templates, blueprints, controllers, models, and snippets. - Check for name collisions and existing patterns:
kirby:kirby_templates_indexkirby:kirby_blueprints_indexkirby:kirby_controllers_indexkirby:kirby_models_index
- If extending an existing type, read it with
kirby:kirby_blueprint_readbefore generating new files. - Use Panel reference resources for field and section choices:
kirby://fieldskirby://sections
- Search the KB with
kirby:kirby_search(examples: "scaffold page type", "blueprints reuse extends", "custom post types", "create a blog section", "one pager site sections"). - Create minimal, convention-aligned files; prefer snippets for reusable view logic.
- Verify with
kirby:kirby_render_page(noCache=true)when runtime is available; otherwise runkirby:kirby_runtime_statusandkirby:kirby_runtime_installfirst. - Optionally run
kirby:kirby_ide_helpers_statusandkirby:kirby_generate_ide_helpers(dry-run first) to keep IDE types in sync.