Liferay Theme Generator

Note: the Liferay theme generator is still in development and is not guaranteed to work on all platforms/environments.

Liferay theme generator allows you to generate new themes to be used with Liferay Portal, and supplies you with the necessary tools to deploy and make quick modifications to your theme.

Dependencies

1. Install Node.JS, if you don't have it yet.
   
2. run <sudo> npm install -g yo gulp to install global dependencies.

Generator use

1. Install generator: <sudo> npm install -g generator-liferay-theme
2. Run yo liferay-theme to start theme generator and follow prompts to name and configure your theme.

Note: the generator will create a new folder in your current directory that will house your theme.

Usage on Windows

Unfortunately, there can be some minor headaches when using the generator on Windows. The main reason is because, by default, we use node-sass, which requires node-gyp to run. node-gyp requires Python and Visual Studio to be installed. You can read more at the following links:
node-gyp Installation
Visual Studio Setup

There is one other possible alternative that some may find easier to setup. You can use the ruby based version of Sass. In order to use that version of Sass, you'll need to install Ruby with the Ruby Installer, and install the Sass and Compass gems from the command line (gem install sass compass), and when the generator asks you if you need Compass support, type "Y". This will bypass node-gyp completely, and use the Ruby versions of Sass and Compass.

Generators

Available generators:

• liferay-theme
• liferay-theme:import
• liferay-theme:layout
• liferay-theme:themelet

Create

yo liferay-theme

The default liferay-theme generator creates a new theme that inherits styles from liferay-theme-styled or liferay-theme-unstyled.

Note: some theme options are deprecated for 7.0, to view the deprecated options run the generator with the --deprecated option.

yo liferay-theme --deprecated

For example, using the deprecated flag will allow you to select Velocity as the template language for 7.0 themes.

Import

yo liferay-theme:import

The liferay-theme:import generator enables you to import pre-existing Liferay themes from the SDK.

Layout

yo liferay-theme:layout

The liferay-theme:layout generator creates a layout template.

If you run the generator from the root directory of a theme (created with yo liferay-theme) it will add the layout template as a part of the theme in src/layouttpl.

Themelet

yo liferay-theme:themelet

The liferay-theme:themelet generator enables you to create theme fragments called themelets.

The advantage of themelets is that reused code/components that often exist in multiple themes can be abstracted and easily reused in all of your themes.

Gulp tasks

Once the generator is done creating your theme, there are multiple gulp tasks available to expedite theme development. See liferay-theme-tasks for more detail.

MIT