Blueprints are configuration files written in YAML that let you customize the Panel to make it truly yours.
- Blueprints are stored in
- Blueprints configure the Panel layout of the site, pages, files and users.
- Start simple with presets.
- Create your own layouts with tabs, columns and sections.
The Panel layouts for
users all get their own blueprints. The blueprint folder is structured accordingly:
File blueprints are located in
/site/blueprints/files and control the Panel setup and form fields for individual file types.
Page blueprints are located in
/site/blueprints/pages and control the Panel setup and form fields for pages.
The Site blueprint is located in
/site/blueprints and controls the Panel setup and form fields for the site/dashboard.
User blueprints are located in
/site/blueprints/users and control the Panel setup, form fields and permissions for a user role.
We added three useful presets (
files) to our blueprints that you can use to create single pages, blogs, galleries and more with almost zero configuration.
With fields you can break up your content into digestable chunks and structure it according to your content model, rather than storing everything in a huge text field. You can add as many fields of different field types as you need.
Kirby comes with a blueprint query language that offers basically the same functionality as Kirby's PHP API with a simple dot notation.
You can store fields, sections, tabs and entire blueprint layouts in separate files so that they can be reused within your blueprints. If you want, you can even create a complete component system to apply to multiple projects.
For editors from various language backgrounds, you can translate blueprint titles, form field labels, section headlines, help text, options, and more.
We have put together an extensive collection of example blueprints for typical setups like a blog, a shop, a project portfolio and more for you to use as a basis for your own.
Our reference has more in-depth documentation about blueprints and their different components.
To use special characters in labels etc., wrap the text in double quotes:
field1: label: "Fotograf*in" type: text field2: label: "Must do: this" type: text
Make sure to only use alpha-numerical characters and underscores in field names. You cannot use dashes.
field_1: label: Headline type: text
field-1: label: Headline type: text