README

一个用于使用组件渲染内容的简单PHP库。

📦 安装

最好使用Composer进行安装，你还可以在Packagist和GitHub上找到该包。

安装时，只需使用以下命令

$ composer require baraja-core/content-storm

你可以通过创建内部类的实例来手动使用该包，或者注册DIC扩展将服务直接链接到Nette框架。

🗺️ 灵感

想象一下数据库中的文章内容

Hello, this is article about cats.

<!-- brj:heading -->
<h3>How to breed a cat?</h3>
<!-- /brj:heading -->

<!-- brj:paragraph -->
<p>The behavior of cats is very simple. It is important to have a <b>lot of meat</b>.</p>
<!-- /brj:paragraph -->

<!-- brj:code -->
Animal
   | Mammal
      | Cat
<!-- /brj:code -->

<!-- brj:my-component {"align":"center","textColor":"#737272","customFontSize":14} -->
This content will be passed to my own component.
The parameters (stored in json) that the component uses for advanced rendering are also passed.
<!-- /brj:my-component -->

在基本用法中，你可以将内容编写为纯HTML。在这种情况下，返回的是你创建的确切相同内容。

通过添加注释标记（例如 <!-- brj:heading -->），你可以将模板的一部分标记为组件。

组件由一个名称（开始和结束标签必须相同）、内容和可选的参数组成。

🛠️ 定义

组件定义为以注释标记（例如 <!-- brj:heading -->）开始并结束（<!-- /brj:heading -->）的文本文件的一部分。

常见语法是

<!-- brj:my-component {"align":"center","textColor":"#737272"} -->
      ^          ^                 ^
      |          |                 |
      ______    _____________    ______________
     /      \  /             \  /              \
<!-- (prefix):(component-name) (json parameters) -->

重要的解析规则

• 组件不能嵌套。
• 开始和结束标签中的名称必须相同。
• 参数以有效的JSON格式编写，可以嵌入。每个参数都始终有一个键（字符串）和一个值（混合类型）。

✅ 调试

如果发生错误，会自动抛出一个ParseException，其中包含有关传入的输入和错误发生的位置的行号的信息。

如果你的项目支持Tracy，错误会直接在传入的文本中以图形方式显示。

🌐 兼容性

此包完全兼容WordPress Post组件系统。此包增加了许多新功能和好处，你将很快就能感受到。

📄 许可证

baraja-core/content-storm采用MIT许可证。有关详细信息，请参阅LICENSE文件。