Configuring a Module Template

Prerequisites

To understand this tutorial, you must comprehend basic Insites concepts, the topics in the 'Get Started' section, modules, and module templates.

• Insites Development Workflow
• Get Started
• Modules
• Module Templates

Steps

Configuring a module template is a three-step process:

• Step 1: Opening the configuration file
• Step 2: Editing the values
• Step 3: Deploying and testing your changes

Step 1: Opening the configuration file

Each module keeps its configurable values in a file called in the module folder, for example . It looks like this:

{
  "slug": "dashboard",
  "title": "This is my dashboard",
  "subtitle": "A beautiful dashboard"
}

The module files use these values with the template tags shown below. The Insites CLI replaces each tag with its value from the file:

---
slug: <%= slug =%>
---
<h1><%= title =%></h1>
<p><%= subtitle =%></p>

Step 2: Editing the values

Change the values in the file. The file must be valid JSON, so do not leave a comma after the last value:

{
  "slug": "dashboard_index",
  "title": "THIS IS A TEST",
  "subtitle": "A very nice dashboard page"
}

Step 3: Deploying and testing your changes

Run , or keep running. Replace with the name of your environment. The CLI fills the values into your module files before it uploads them.

Then load the URL of your instance with the slug you set, for example . The page shows the new title, THIS IS A TEST.