presprog/kirby-block-loader

将区块蓝图和代码片段放在一个地方

维护者

详细信息

github.com/presprog/kirby-block-loader

源代码

问题

安装: 0

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 0

开放问题: 0

类型:kirby-plugin

0.1.0 2024-02-12 20:43 UTC

Requires

  • php: ^8.1

Requires (Dev)

MIT ba07babc41b6f8249960537293839a3e80c59cf3

This package is auto-updated.

Last update: 2024-09-13 08:53:16 UTC

README

⚡ 在一个地方管理您的 蓝图 和 代码片段

// Have everything nicely grouped together. Let our plugin do the heavy lifting.
📂 site
    📂 blocks
        📂 call-to-action
            📄 call-to-action.yml   // Block blueprint
            📄 call-to-action.php   // Block snippet

默认情况下，您将自定义区块的蓝图和代码片段存储在不同的位置：蓝图存放在 site/blueprints/blocks，代码片段存放在 site/snippets/blocks。为什么不将构成新区块的所有文件放在一个文件夹中，并让此插件负责加载和注册所有内容呢？

如何使用

假设您想添加一个自定义的 行动号召 区块。至少需要一个蓝图和一个代码片段。我们使用此插件将它们整齐地组合在一起，而不是将它们分别放置在不同的文件夹中

  1. 创建一个 site/blocks 文件夹。所有自定义区块都将放在这里。您可以在 index.php 中使用自定义的 blocks 根来配置此文件夹。
  2. 在 site/blocks 中创建一个名为 call-to-action 的文件夹。蓝图和代码片段将放在这里。
  3. 添加一个名为 call-to-action.yml 的文件，设置您的蓝图
  4. 添加一个名为 call-to-action.php 的文件，以您希望在其它代码片段中呈现的方式渲染区块。

插件将扫描文件夹，并将蓝图和代码片段注册为 blocks/call-to-action

// […]
    'blueprints' => [
        'blocks/call-to-action' => 'site/blocks/call-to-action/call-to-action.yml',
    ], 
    'snippets' => [
        'blocks/call-to-action' => 'site/blocks/call-to-action/call-to-action.php',
    ],
// […]

安装

Composer

composer require {{ your-name }}/block-loader

下载

下载并将此存储库复制到 /site/plugins/block-loader。

Git 子模块

git submodule add https://github.com/presprog/block-loader.git site/plugins/block-loader

待办事项

  • 从区块子文件夹加载区块预览。

许可证

MIT

替代方案

microman/components 试图解决这个问题，并引入了组件的新概念。这是一个更灵活的方法，因为组件可以是任何东西。我们的插件仅适用于区块。

由 Present Progressive 使用 ❤️ 和 ☕ 制作