Skip to content

Plug-in API

Indiekit is a Node.js Express server designed to interoperate with IndieWeb protocols and features. Plug-ins allow new features to be added, and different protocols and specifications to be supported.

A plug-in can provide any of the following features:

Anatomy of a plug-in

A plug-in is a Class with an init() function that is used to register endpoints, presets, stores and syndicators. You can also use the init() function to modify Indiekit’s configuration. For example:

export default class PluginName {
  constructor() { = "Plugin name";

  syndicate() {…}

  init(Indiekit) {
    // Register a plug-in method

    // Update Indiekit’s configuration = "bar"

Folder structure

Indiekit expects plug-in packages to provide assets in the following directories:

Folder nameContents
/assetsStatic files (for example images, stylesheets). Optional.
/includesNunjucks partials used in views. Optional.
/localesLocalisation files. Optional.
/viewsNunjucks view templates. Optional.

Plug-in icon

To provide an icon for your plug-in, include a square shaped SVG file at /assets/icon.svg.

Homepage widget

To provide a small widget for the signed-in homepage, include a Nunjucks file at /includes/[module-name]-widget.njk, and use the widget component to ensure correct markup and styling. Here’s an example.