Theme Builder Plugin

The Theme Builder plugin lets you build Liferay theme files in your project. Visit the Building Themes in a Maven Project tutorial to learn more about applying Theme Builder to your Maven project.


To use the plugin, include it in your project’s root pom.xml file:


You can view an example POM containing the Theme Builder configuration here.


The plugin adds one Maven goal to your project:

theme-builder:buildBuilds the theme files.

Available Parameters

You can set the following parameters in the <configuration> section of the POM:

Parameter NameTypeDefault ValueDescription
diffsDirFile${maven.war.src}The directory that contains the files to copy over the parent theme.
nameString${project.artifactId}The name of the new theme.
outputDirFile${}/${}The directory where to build the theme.
parentDirFilenullThe directory of the parent theme.
parentNameStringnullThe name of the parent theme.
templateExtensionString"ftl"The extension of the template files, usually "ftl" or "vm".
unstyledDirFilenullThe directory of Liferay Frontend Theme Unstyled.

You can also manage the com.liferay.frontend.theme.styled and com.liferay.frontend.theme.unstyled default theme dependencies provided by the Theme Builder in your pom.xml. They can be modified by adding them as project dependencies:


There is an additional Liferay theme-related dependency you can manage this way that’s provided by the CSS Builder. See this section for more information.

« Source Formatter PluginTLD Formatter Plugin »
Was this article helpful?
0 out of 0 found this helpful