Getting Started

Five independent helpers for the templates and config of a Kirby site – environment variables, meta tags, a sitemap, redirects, and Vite assets.

Kirby Helpers is a plugin for Kirby CMS with five helpers for your templates and config.php. Each works on its own: the sitemap, robots.txt, and redirects stay off until you configure them, and the rest are functions you call.

Install the Plugin

Composer

The recommended way to install the plugin:

composer require johannschopplich/kirby-helpers

ZIP File Download

Download the latest release or head over to the releases page to see all versions. Extract the ZIP file to your site/plugins folder. Installed this way, env() is not available in config.php – see Environment Variables.

The plugin runs on Kirby 5.

The Helpers

Helper	Entry Point
Environment Variables	`env('KEY', $default)`
Meta Tags	`$page->meta()->social()`
Sitemap and `robots.txt`	`sitemap.enabled` and `robots.enabled`
Redirects	`redirects`
Vite	`vite()->js()` and `vite()->css()`

Options live under johannschopplich.helpers in config.php:

site/config/config.php

return [
    'johannschopplich.helpers' => [
        'sitemap' => [
            'enabled' => true
        ]
    ]
];