Skip to content

Latest commit

 

History

History
59 lines (42 loc) · 2.99 KB

README.md

File metadata and controls

59 lines (42 loc) · 2.99 KB

Craft themes (4.x)

This is a theme engine for Craft CMS 4.0, it allows you to create themes that are reusable and extendable.

Themes are regular plugins, as such they can have their own settings, migrations etc, but now have a set of templates and assets that will inherit themselves, allowing for faster frontend development.

A rule system allows you to define which theme will be used for which site, language, view port or url path. Or a mix of those 4.

Make use of the built-in compiler to compile scss files or scss inlined in your templates. Scss will use inheritance too !

The pro version aims at taking control over how pages are displayed using an interface in the backend and a theme engine that is reusable, adaptable and easy to use.
Themes are regular Craft plugins, as such they can be shared on the store, installed from packagist or created by yourself. They can have settings and migrations and most importantly extend each other.
Craft backend is amazing but if you're not a developer making a frontend can be a bit daunting, the pro version should alleviate this by doing a lot of the work for you.

The lite version will allow you to :

  • Install themes from the store or any git repository (composer, github, local filesystem etc)
  • Define your own themes that can extend each other
  • Choose which theme will be used for which site, language, viewport or url path according to a set of rules.
  • Compile scss files

The Pro version will allow you to :

  • Define regions in your themes
  • Assign blocks to the themes regions
  • Define your own blocks
  • Define your own view modes for each entry types/category groups/global sets/tag groups/volumes/users layouts
  • Choose how your fields and assets are displayed on the front end depending on their view modes and options
  • Define your own fields and assets displayers
  • Use a templating cascading system that allows bespoke rendering
  • Eager load fields automatically
  • Use several caching layers for faster rendering

What it doesn't allow you to do :

  • Change the backend look and feel
  • Override plugins templates (unless specific case, see developers readme)

Consult the documentation for further details on how to use those features.

Requirements

  • Craft ^4.0
  • PHP 8.0 or over
  • PHP Intl extension

Testing

This plugin is unit tested with mysql 5.7, postgresql 12.8, Craft 4.0 and php 8.0/8.1.

Documentation

Roadmap/Ideas

  • Themes preferences not related to project config
  • Restricted version of blocks page for envs where admin changes are disabled
  • Improve displayer cache by not saving the ones that didn't change
  • Add a Theme tab to the debug bar
  • Add a project config tracked data version to warn when layouts need rebuilt