How to publish your plugin

There are two places, where you can publish your plugin.

Add a readme

Make sure to add a useful readme with instructions to your plugin.

Add a package.json

By adding a package.json file at the root of your repository, you allow others to install and update your plugin using the Kirby CLI.

{
  "name": "your-plugin-name",
  "description": "Short description of your plugin",
  "author": "Firstname Lastname <you@provider.com>",
  "version": "1.0.0",
  "type": "kirby-plugin",
  "license": "your-license (e.g. MIT)"
}

Put it on Github, Bitbucket or Gitlab

We highly recommend, that you put it in a public git repository, so other developers can clone, update it or even contribute to it.

License

We don't require any specific license for plugins. Go for whatever works best for you.

Tell others about it

Kirby Forum

It's always a good idea to let others know about your plugin in the forum. Just sign-up and create a post in the plugins category.

@getkirby

We are always happy to tweet about new plugins. Just ping us on Twitter and we can publish it there.

getkirby-plugins.com

This site is run and maintained by Jonas Döbertin. You can ping him on Twitter and he will add your plugin to the list.

github.com/jenstornell/kirby-plugins

Jens Törnell and John Coyne started this massive repository, which collects all plugins from all over the place. It's definitely worth posting your plugin there as well.