Developing Extensions
Development
Extension
PHP
Package
Introduction
Options
Autoloading Assets
Usage
Related Items
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.
System
Installing Packages
- System
Automad can be easily extended by installing custom packages. A package can be a theme or a PHP extension or a combination of both. Installing packages is as simple as cloning or extracting them into the packages directory.
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 engine also allows beginners to develop their own themes and templates, at the same time it is ...
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 engine enables also inexperienced developers or beginners to create themes and templates on their own. In case you ...
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 Engine
- Building Themes
Automad's template engine 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 wider range of methods ...
Template Engine
Using Extensions
- Template Engine
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 functions.
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. Missing ...
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.
Developer Guide
Tutorials
- Developer Guide
To get started right away with developing your own package, please check out the tutorials bundled with Automad. The Tutorial package is a good and simple example for how things are organized and what are the essential parts of an Automad package.
API Reference
Getting Started
System
User Guide
API Reference
Developer Guide
Building Themes
Developing Extensions
Editor Plugins
Tutorials