Automad / Cheat Sheets

Try a Demo ♡ Sponsor
Cheat Sheets

#Cheat Sheet #Development #Extension #Theme
In case you prefer to start developing a theme or extension without reading the full documention, the cheat sheets below are a good point to start. In addition to this page there is also the theme skeleton package available to help you getting started.

Chapters
More in Cheat Sheets
Related

System ⁄
Debugging — System
During development of extensions it can be handy to see what Automad is doing. Therefore it is possible to send logging information to your browser's console. You can log any item, object or just a text notice using the following method in your extension or theme.
Developer Guide
Extensibility is one of the most important features of any software. Basically there are two types of packages to extend the functionality of Automad: themes and extensions. While Automad's template language allows beginners to develop their own themes, it is also possible to use ...
Developer Guide ⁄
Building Themes — Developer Guide
Themes are an essential part of a content management system. They define the way your content is presented to the visitors of your website. Automad's flexible and intuitive template language enables also inexperienced developers or beginners to create themes and templates on ...
Building Themes ⁄
theme.json — Building Themes
Every theme needs a theme.json to work. As mentioned before, all subdirectories of the packages directory containing a theme.json side by side with at least one template are to be considered as valid themes. Please see the list below for all required fields.
Building Themes ⁄
Template Language — Building Themes
Automad's template language provides a flexible and safe way to render content dynamically. In contrast to other generic template engines, the Automad core functions are integrated into the engine. That includes such things as image processing as well as a the access to an even ...
Template Language ⁄
Using Extensions — Template Language
Extensions provide a convenient way of turning custom PHP code into Automad statements. Besides the fact that extensions have to be called by their names including their namespace, the syntax is the same as for Toolbox or pipe functions.
Building Themes ⁄
Block Layouts — Building Themes
Aside from just stacking blocks on top of each other, Automad's block editor provides some handy features to create flexible layout directly in the block editor. It is possible to stretch a block to the full with of the parent container to make it stand out as well as to arrange ...
Building Themes ⁄
Customizing Blocks — Building Themes
Most of the blocks only consist of pure HTML tags without classes and just inherit theme styles when being displayed. However the default styling of more complex blocks like the mail form or the gallery block might not be matching a theme out of the box. You can use CSS custom ...
Building Themes ⁄
Plain PHP — Building Themes
Automad supports plain PHP in template files. However, variables used in plain PHP blocks will not show up automatically in the dashboard and mixing PHP with Automad's template engine should be done carefully. Therefore it is not recommended to use plain PHP in normal templates. ...
Developer Guide ⁄
Developing Extensions — Developer Guide
The extension interface provides a convenient way of extending Automad's core functionality with custom PHP code while still offering Automad's template syntax. There are basically two types of template language extensions: generic extensions and custom pipe functions. Check out ...
Developing Extensions ⁄
Generic Extensions — Developing Extensions
In case you are missing any advanced feature while developing themes using Automad's template language, you are able to implement that functionality as a generic extension written in plain PHP.
Developing Extensions ⁄
Custom Pipe Functions — Developing Extensions
Automad provides already some basic string manipulation functions to be used with the pipe operator. However, in some cases it my be necessary to use a custom function to modify the content of a variable. Custom pipe functions can be written in plain PHP. Thier basic setup is ...
Developer Guide ⁄
Publishing Packages — Developer Guide
Automad uses Composer as dependency manager. Therefore packages can be made public by submitting them as Composer packages to the Packagist website. Published Automad packages also automatically appear in the package browser. The process of releasing a package is basically the ...
Developer Guide ⁄
Editor Plugins — Developer Guide
To make the development of themes more efficient, it is recommended to install one of the Automad plugins for the editors listed below. Those plugins will add syntax highlighting for the Automad template engine as well as the most common snippets for autocompletion.
Cheat Sheets ⁄
Useful Template Snippets — Cheat Sheets
Find below a collection of useful snippets for common tasks using Automad's template language.
Cheat Sheets ⁄
Plain PHP Snippets — Cheat Sheets
In case you want to develop a new extension or use PHP in your templates, the collection of common code snippets below might help you getting started quickly.
Cheat Sheets ⁄
Creating Theme Packages — Cheat Sheets
This guide describes step by step the workflow of setting up and publish a new theme. It assumes you're familiar with Visual Code Studio and working on a system with a Bash shell or similar — like macOS or Linux.
Headless Mode
Activating the headless mode turns Automad into a back-end only content management system without a presentation layer that focuses entirely on content creation. While the Dashboard can still be used to manage content, all data and files are made accessible via a read-only JSON ...
Discuss
Packages
Release Notes
Support
Terms of Use

Become a Sponsor
GitHub
Twitter
Facebook
Instagram

2013-2024 by Marc Anton Dahmen
Released under the MIT license

A faceless machine, creating one's portrait in the internet.