README

这是 Kirby 的定制 Composer 安装程序，用于 Kirby CMS。如果您通过 Composer 安装 CMS，它将自动选择正确的安装路径。

它还可以自动将 Kirby 插件安装到 site/plugins 目录。

安装 CMS

默认配置

如果您在自己的 composer.json 中 require 了 getkirby/cms 包，则无需执行其他操作

{
  "require": {
    "getkirby/cms": "^3.0"
  }
}

Kirby 的 Composer 安装程序（此存储库）将自动运行，并将 CMS 安装到 kirby 目录。

自定义安装路径

您可能想使用不同的安装路径。您可以在 composer.json 中这样配置路径

{
  "require": {
    "getkirby/cms": "^3.0"
  },
  "extra": {
    "kirby-cms-path": "kirby" // change this to your custom path
  }
}

禁用 CMS 的安装程序

如果您希望将 CMS 安装到 vendor 目录，您可以将自定义路径完全禁用

{
  "require": {
    "getkirby/cms": "^3.0"
  },
  "extra": {
    "kirby-cms-path": false
  }
}

请注意，您需要修改您网站的 index.php 以加载 vendor/autoload.php 文件而不是 Kirby 的 bootstrap.php 文件。

安装插件

已发布插件中的支持

插件需要将此安装程序作为 Composer 依赖项来使用自动安装到 site/plugins 目录。

您可以在我们的 插件文档 中了解更多信息。

插件用户的用法

作为支持此安装程序的 Kirby 插件的用户，您只需要在您网站的 composer.json 中 require 插件

{
  "require": {
    "getkirby/cms": "^3.0",
    "superwoman/superplugin": "^1.0"
  }
}

安装程序（此存储库）将自动运行，因为插件开发者将其添加到插件的 composer.json 中。

自定义安装路径

如果您的 site/plugins 目录位于自定义路径，您可以在 composer.json 中这样配置安装路径

{
  "require": {
    "getkirby/cms": "^3.0",
    "superwoman/superplugin": "^1.0"
  },
  "extra": {
    "kirby-plugin-path": "site/plugins" // change this to your custom path
  }
}

什么是 Kirby？

• getkirby.com – 了解 CMS。
• 试用它 – 使用我们的在线演示进行测试。或者下载我们的套件以开始。
• 文档 – 阅读官方指南、参考和食谱。
• 问题 – 报告错误和其他问题。
• 反馈 – 您对 Kirby 有想法？分享它。
• 论坛 – 遇到问题时，请不要犹豫，寻求问题和支持。
• Discord – 闲逛并结识社区。
• Mastodon – 传播信息。
• Instagram – 分享您的作品：#madewithkirby。

许可协议

http://www.opensource.org/licenses/mit-license.php

作者

Lukas Bestle https://getkirby.com