Skip to content

Superlite CMS

Modules

Modules add functionality to Superlite without adding everything to the CMS core.

A module can extend the administration interface, add editor tools, connect Superlite to an external service, create new content types or change how parts of the website are generated.

This keeps the Superlite core small while allowing each website to install the functionality it actually needs.

What a module is

A module is an optional package that adds functionality to an existing Superlite installation.

Examples of functionality that can be provided by modules include:

  • Articles
  • AI writing tools
  • Google Analytics 4
  • Google Search Console verification
  • Cookie consent
  • Markdown import
  • Integrations with external services

Different Superlite websites can therefore have different functionality even when they use the same version of the CMS.

Core features and modules

Superlite separates essential CMS functionality from optional functionality.

Features that almost every website needs belong in the core.

Examples include pages, media, navigation, SEO, redirects, themes and publishing.

Features that are only useful for some websites are normally implemented as modules.

This prevents the core from becoming unnecessarily large or dependent on external services.

Opening Modules

Open Modules from the main Superlite navigation.

The Modules section shows the modules currently installed on the website.

Depending on the module, the list can show information such as:

  • Module name
  • Version
  • Status
  • Compatibility
  • Available update

From this section you can install, activate, deactivate and manage modules.

Installing a module

Modules can be installed from the available module library or from a Superlite module ZIP package.

When installing a module, Superlite checks the package before making it available.

The module contains information that identifies it and specifies which versions of Superlite it supports.

If the module is not compatible with your installed Superlite version, you may need to update Superlite first.

Installing a module from ZIP

If you have a module ZIP package, open Modules and choose the option to install a module.

Select the ZIP file from your computer and upload it.

Superlite validates the package before installing it.

Once installation is complete, the module appears in the list of installed modules.

Installing a module does not necessarily activate it automatically.

Activating a module

An installed module normally needs to be activated before its functionality becomes available.

Open Modules, find the module and choose Activate.

What happens after activation depends on the module.

A module may:

  • Add a new section to the administration interface
  • Add settings
  • Add controls to the editor
  • Add a new content type
  • Change how pages are generated
  • Connect Superlite to another service

Some modules require additional configuration before they can be used.

Deactivating a module

A module can be deactivated without necessarily removing it.

Open Modules, select the active module and choose Deactivate.

The module files remain installed, but its functionality is disabled.

This is useful when troubleshooting or when you temporarily do not want to use a particular feature.

What happens to information created by the module depends on the module itself.

For example, deactivating a module should not normally mean that its saved settings or content are immediately deleted.

Read the documentation for the individual module before removing it permanently.

Module settings

Modules can add their own settings to Superlite.

These settings can appear directly in the Modules section or in another part of the administration interface, depending on how the module works.

For example, an integration module may require an identifier or API key.

A cookie consent module may provide settings for how consent should be handled.

An editor module may add configuration for how its tools behave.

Each module has its own manual where the available settings are explained.

Module compatibility

A module can specify the Superlite versions it supports.

This prevents a module from being used with a version of the CMS that does not provide the functions it requires.

If Superlite reports that a module requires a newer CMS version, update Superlite before installing or activating that module.

Do not ignore compatibility warnings.

A module built for a newer version may rely on functionality that does not exist in an older installation.

Module versions

Modules have their own version numbers.

The module version is separate from the Superlite version.

For example, you may be running one version of Superlite and version 1.3.0 of a particular module.

Version numbers make it possible to identify updates and determine exactly which release is installed when troubleshooting.

Updating a module

When a newer version of an installed module is available, Superlite can show that an update exists.

Open Modules and review the available updates.

Install the new version using the update option.

A module update can contain new features, compatibility changes or fixes.

Existing module configuration should normally remain in place unless the module documentation states otherwise.

Updating a module from ZIP

A module can also be updated manually using a newer ZIP package.

Upload the new package through the module installation function.

The package should identify itself as the same module and contain a newer version.

Superlite can then replace the installed module files while preserving the website itself.

After updating, review the module settings and test the functionality that the module provides.

Removing a module

A module that is no longer needed can be removed.

Deactivate it first.

Then use the remove option where available.

Removing a module deletes the module files from Superlite.

Before removing a module, consider whether it manages content or configuration that you may want to keep.

Some modules can create content that remains useful even after the module is disabled, while others may provide functionality required to display or manage that content correctly.

The individual module documentation should explain any special removal considerations.

Modules can extend the editor

Modules can add functionality to the Superlite editor.

For example, a module can add a new block, an import tool or an additional action for existing text.

When this happens, the new functionality appears alongside the standard editor tools.

If an editor feature provided by a module is missing, check that the module is installed and activated.

Modules can add content types

Modules can also add new types of content.

The Articles module is an example.

Pages are part of the Superlite core, while Articles can be installed as an additional content type through a module.

Once the module is activated, Articles can appear as a separate section in the administration interface and use the same underlying Superlite publishing system.

Other modules can use the same architecture to add specialized content types in the future.

Modules can connect to external services

Some modules connect Superlite to services outside your web server.

For example, a module can connect the website to Google Analytics or an AI service.

These modules may require additional configuration such as an API key, measurement ID or verification code.

External services are not required for the basic operation of Superlite.

If the external service becomes unavailable, the already generated public website should continue to function as far as possible.

Modules and API keys

Some modules require credentials such as API keys.

Sensitive keys should be stored on the server and should not be exposed in the public HTML or sent unnecessarily to the browser.

Follow the instructions for the individual module when adding credentials.

Never publish an API key inside page content or manually add it to public JavaScript unless the service specifically uses a public identifier intended for that purpose.

Modules and publishing

Modules can participate in the Superlite publishing process.

For example, a module can add metadata, modify generated output or create additional pages.

Modules can also use the internal Superlite functionality to create or update content.

This means content created by a module can use the same publishing, validation and revision mechanisms as content created manually.

Modules and the public website

A module does not automatically make the public website dynamic.

Superlite is still designed around static HTML.

A module can provide functionality while the resulting pages are generated as static files.

Some integrations may add JavaScript or other resources to the public site when that is required by the feature.

Only the module or theme that needs those resources should add them.

Module errors

A problem in one module should not normally make already published pages unavailable.

The public website consists primarily of static files, so existing pages can continue to be served even if a module in the administration interface has a problem.

If a module causes an error, deactivate it and check whether the problem disappears.

You can then verify:

  • The installed module version
  • The required Superlite version
  • The module settings
  • Any external service configuration
  • Available updates

Technical errors can also be recorded in the Superlite system log.

Troubleshooting a module

If a module does not work as expected, first confirm that it is installed and activated.

Then check whether it requires configuration.

If the module connects to an external service, verify the identifiers or credentials required by that service.

Also check compatibility between the module version and your installed Superlite version.

If the problem started after an update, check whether another version of the module or Superlite is required.

Module specific documentation

Each larger Superlite module has its own guide.

The general Modules section explains how modules are installed, activated, updated and removed.

The individual module guides explain how to use the functionality that each module adds.