Kirby Boiler Plugin

Version 0.1

Going to make Kirby plugin? Here is a boilerplate.

Installation

Use one of the alternatives below.

1. Kirby CLI

If you are using the Kirby CLI you can install this plugin by running the following commands in your shell:

$ cd path/to/kirby
$ kirby plugin:install jenstornell/kirby-boiler-plugin

2. Clone or download

1. Clone or download this repository.
2. Unzip the archive if needed and rename the folder to kirby-boiler-plugin.

Make sure that the plugin folder structure looks like this:

site/plugins/kirby-boiler-plugin/

3. Git Submodule

If you know your way around Git, you can download this plugin as a submodule:

$ cd path/to/kirby
$ git submodule add https://github.com/jenstornell/kirby-boiler-plugin site/plugins/kirby-boiler-plugin

Usage

Most of the things you need should be in the files, but you need to know the basics of Kirby plugin development to get started.

Don't use the included readme.md

The readme.md is used for this page, but you can download a proper readme file here.

Changelog

0.1

• Initial release

Requirements

• Kirby 2.3+

Disclaimer

This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please create a new issue.

License

MIT

Credits

• Jens Törnell