CreatePagePlugin

A plugin for Magnolia CLI to create a headless or freemarker-based page

Installation

Using add-plugin

1. Run the following command in the project's root directory:

   npm run mgnl -- add-plugin @magnolia/cli-create-page-plugin

   The command will install the plugin, and automatically register the plugin in mgnl.config.js file:

   import CreatePagePlugin from "@magnolia/cli-create-page-plugin";
   
   export default {
     plugins: [
       new CreatePagePlugin()
     ]
   };

2. To confirm that the plugin has been successfully installed, run:

   npm run mgnl -- create-page --help

Manually

1. Run the following command in the project's root directory:

   npm install @magnolia/cli-create-page-plugin

2. Manually add CreatePagePlugin to mgnl.config.js file:

   import CreatePagePlugin from "@magnolia/cli-create-page-plugin";
   
   export default {
     plugins: [
       new CreatePagePlugin()
     ]
   };

3. To confirm that the plugin has been successfully installed, run:

   npm run mgnl -- create-page --help

Usage

Options

| Short | Long | Description | |-------------------|-------------------------------------------------|--------------------------------------------------------------------------------------------------------| | -lm [name] | --light-module [name] | set the light module for the page template; defaults to the directory specified in mgnl.config.js file | | -p [name] | --prototype [name] | select a prototype for page creation | | -v | --version | output the version number | | -h | --help | display help for command |

Configurable Properties in mgnl.config.js

Global Properties

| Property | Description | |-----------------------|-----------------------------------------------------------| | pageMappingFilePath | The path to the file containing the pagesMapping object | | lightModulesPath | The directory with all light modules | | lightModule | The selected light module | | type | The type for the selected prototype, e.g., ts or js |

Plugin-Specific Properties

| Property | Description | |----------------|-------------------------------------------------------------------------------------------| | pagesSpaPath | The path to the folder containing the front-end pages | | lightModule | The selected light module | | framework | The framework prototype to use for page creation (e.g., @magnolia/cli-react-prototypes) | | prototype | The name of the prototype to be used | | templateData | A key-value object used by Handlebars for template rendering | | templateArgs | A key-value object that modifies how the prototype behaves |

Examples

Create a page

npm run mgnl -- create-page "myFooPage" --framework "@magnolia/cli-react-prototypes" --prototype "basic"

This command creates a new page called "myFooPage" based on "basic" prototype from "@magnolia/cli-react-prototypes" framework. If any properties (e.g., lightModulesPath, lightModule, framework, etc.) are missing from the mgnl.config.js file, the plugin will prompt you to provide them. The entered values will be saved in the mgnl.config.js file for future use.

Create a page with a specific light module

npm run mgnl -- create-page "myFooPage" --lightModule "myLm"

This command creates a new page called "myFooPage" within the "myLm" light module and updates the lightModule property in mgnl.config.js. As with the previous example, missing properties will be prompted for and saved.

Plugin Documentation

For detailed documentation of the plugin, please refer to Plugin Documentation

Magnolia CMS

This plugin is created to work with Magnolia CMS. For more information, please refer to Magnolia CMS Documentation