Light modules
DX Cloud allows you to leverage the power of light-modules combined with your java development.
Light module pages for DX Cloud:
-
Informs you on what you can do with light modules in Magnolia light modules.
-
Lays out the proper light-module structure for your CI/CD pipeline in Light Module deployment.
Magnolia light modules
A Magnolia light module is a file and folder-based module. It can define every Magnolia item which can be configured in YAML – such as apps, content types, templates, dialogs, themes, and others. It can also contain a lightweight YAML-based module descriptor and web resources such as css and javascript files.
Light modules can be built with a simple text editor, with no special tools (such as Maven) required.
A light module cannot incorporate java classes.
|
What items can be defined in a light module?
The following items can be defined within a light module using YAML. Items defined by YAML can be decorated, or can be reused with YAML inherit and include.
-
Content type definitions
|
Non YAML-based items can also be used/found in
|
Creating a light module with Magnolia CLI
Using the Magnolia CLI you can create the folder structure for a light module with the command create-light-module.
-
Ensure you have Magnolia CLI v5 installed:
mgnl -VYou should see something similar to the following:
Magnolia CLI: 5.0.0 (node.js: v20.13.1)
-
Go to your light modules directory, and execute the following command:
npm run mgnl -- create-light-module <light-module>
When creating a name for a module, do not use spaces, accented characters such as é, à, ç, ä, ö, ü or special characters (e.g. slashes /, \ and so on). The name must match the regular expression [a-zA-Z0-9-_].
|