Skip to content

A little template to boost our plugin development for Kirby CMS

License

Notifications You must be signed in to change notification settings

presprog/kirby-skeleton-plugin

Repository files navigation

Kirby Skeleton Plugin

My Kirby plugin readme

This is our boilerplate for Kirby plugins. Put a short description of what your plugin does here.

⚡ Ready for Kirby 4!


Note

Delete this section after you are done.

This is our boilerplate for Kirby plugins. Create a project from this repository to create a new plugin and adjust the files accordingly:

# Adjust `my-new-kirby-plugin` to whatever you want to name the output folder
composer create-project presprog/kirby-skeleton-plugin my-new-kirby-plugin
  1. Update composer.json:
  • Update the package name
  • Update the PSR-4 namespace (or remove entirely)
  • Update the installer name (or remove entirely)
  1. Set the package name in index.php
  2. Set the package name in panel/index.js
  3. Add badges, if you like
  4. Write a proper README.md for your plugin

🚀 How to use

⚙️ Config

💻 How to install

Install this plugin via Composer:

composer require presprog/my-kirby-plugin

Or download the ZIP file from GitHub and unpack it to site/plugins/my-kirby-plugin

✅ To do

📄 License

MIT License Copyright © 2024 Present Progressive


Made by Present Progressive for the Kirby community.