README

A ProcessWire module adding Pug to the TemplateEngineFactory.

Requirements

• ProcessWire 3.0 or newer
• TemplateEngineFactory 2.0 or newer
• PHP 7.0 or newer
• Composer

The 1.x version of this module is available on the 1.x branch. Use this version if you still use TemplateEngineFactory 1.x.

Installation

Execute the following command in the root directory of your ProcessWire installation:

composer require dreerr/template-engine-pug:^2.0

This will install the TemplateEnginePug and TemplateEngineFactory modules in one step. Afterwards, don't forget to enable Pug as engine in the TemplateEngineFactory module's configuration.

Configuration

The module offers the following configuration:

• Template files suffix The suffix of the Pug template files, defaults to pug.
• Provide ProcessWire API variables in templates API variables ($pages, $input, $config...) are accessible in Pug.
• Output indented HTML If checked, the output is rendered as indented HTML.
• Debug Output When an error occurs at render time, you will get a complete stack trace including line and offset in the original pug source file.
• Enable Profiler When set to true, it will output on render a timeline you can inspect in your browser to see wich token/node take longer to lex/parse/compile/render.