https://github.com/gplopes/moi-shared
kirby3 sharedkit
https://github.com/gplopes/moi-shared
Last synced: about 1 year ago
JSON representation
kirby3 sharedkit
- Host: GitHub
- URL: https://github.com/gplopes/moi-shared
- Owner: gplopes
- License: mit
- Created: 2020-02-25T22:43:54.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-03-29T18:16:45.000Z (about 6 years ago)
- Last Synced: 2025-02-01T16:22:01.791Z (over 1 year ago)
- Language: CSS
- Size: 633 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Kirby Pluginkit: Example plugin for Kirby
> Variant "Basic setup"
This is a boilerplate for a Kirby plugin that can be installed via all three [supported installation methods](https://getkirby.com/docs/guide/plugins/plugin-setup-basic#the-three-plugin-installation-methods).
You can find a list of Pluginkit variants on the [`master` branch](https://github.com/getkirby/pluginkit/tree/master).
---
## How to use the Pluginkit
1. Fork this repository
2. Change the plugin name and description in the `composer.json`
3. Change the plugin name in the `index.php`
4. Change the license if you don't want to publish under MIT
5. Add your plugin code to the `index.php`
6. Update this `README` with instructions for your plugin
We have a tutorial on how to build your own plugin based on the Pluginkit [in the Kirby documentation](https://getkirby.com/docs/guide/plugins/plugin-setup-basic).
What follows is an example README for your plugin.
---
## Installation
### Download
Download and copy this repository to `/site/plugins/moi-shared`.
### Git submodule
```
git submodule add https://github.com/gplopes/moi-shared.git site/plugins/moi-shared
```
### Composer
```
composer require {{ your-name }}/{{ plugin-name }}
```
## Setup
_Additional instructions on how to configure the plugin (e.g. blueprint setup, config options, etc.)_
## Options
_Document the options and APIs that this plugin offers_
## Development
_Add instructions on how to help working on the plugin (e.g. npm setup, Composer dev dependencies, etc.)_
## License
MIT
## Credits
- [Your Name](https://github.com/ghost)