shallowred / kirby-images
Kirby 示例插件
0.1.1
2024-09-26 08:52 UTC
Requires
- getkirby/composer-installer: ^1.1
- timnarr/kirby-imagex: ^0.1.2
README
变体 "使用 Composer 依赖项设置"
这是一个Kirby插件的模板,可以通过所有三种支持安装方法安装。
您可以在master
分支上找到Pluginkit变体列表。
如何使用Pluginkit
- 将该仓库Fork
- 在
composer.json
中更改插件名称和描述 - 在
index.php
中更改插件名称 - 如果您不想在MIT下发布,请更改许可证
- 将您的插件代码添加到
index.php
和src
目录 - 使用
composer require
要求Composer依赖项 - 使用您插件的说明更新此
README
我们在Kirby文档中有一个关于如何基于Pluginkit构建您自己的插件的教程。
以下是一个插件示例README。
安装
下载
下载并将此仓库复制到/site/plugins/{{ plugin-name }}
。
Git子模块
git submodule add https://github.com/{{ your-name }}/{{ plugin-name }}.git site/plugins/{{ plugin-name }}
Composer
composer require {{ your-name }}/{{ plugin-name }}
设置
有关如何配置插件的附加说明(例如蓝图设置、配置选项等)
选项
记录此插件提供的选项和API
开发
添加有关如何帮助开发插件的说明(例如npm设置、Composer开发依赖项等)
许可证
MIT