/craft-conventions

Opinionated conventions for organising CraftCMS templates

Primary LanguagePHPMIT LicenseMIT

Conventions plugin for Craft CMS 4.x

Latest Stable Version Buy us a tree License

The Conventions plugin helps you maintain a consistent template structure both within and across your Craft CMS projects, by making it easy to define and use twig helper functions that act as improved replacements for Twig's native {% include %} tag. These functions are designed to help you write cleaner, more consistent templates with less boilerplate.

Turn this:

{% include('_components/blog/card') with { data: myData } only %}

Into this:

{{ component('card/blog', { data: myData }) }}

with just a single line definition in a config file.

Features

  • Works out-of-the-box with default options
  • Flexible config options
  • Easily customisable for advanced use-cases

How to use

Read the documentation

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Conventions Roadmap

  • Tests!
  • Add generators for scaffolding new patterns
  • Styleguide generator intergration 🧐

Brought to you by Zaengle Corp