README

持续集成	代码质量审查	单元测试覆盖率

概述

欢迎！scr-be/teavee-html-generator-bundle包通过实现以下功能提供创建HTML组件生成器的框架：

• 定义数据检索逻辑的抽象“提供者”
• 定义渲染逻辑的抽象“生成器”
• 接口上述组件、处理可选的缓存操作并提供简单用户API的抽象“管理器”
• Twig扩展注册抽象

分组

此包是teavee组的一部分（说明），该组由其他发布版本组成，专注于媒体、HTML、内容、生成器和相关的功能。

JTT

此包代表在大量开源代码集合中单个项目，这些代码在Scribe命名空间下发布，包括框架无关的库和多个Symfony包。这些项目由Rob Frawley 2nd和协作者编写和维护，通常在Scribe Inc的支持下。

快速入门

安装

通过使用Composer CLI显式要求代码，或通过编辑您的composer.json文件以反映依赖关系并更新您的项目要求来获取代码。例如，要使用CLI显式要求此项目，请使用以下命令。

$ composer require scr-be/teavee-html-generator-bundle

要启用包，通过在bundle数组中实例化ScribeTeaveeHtmlGeneratorBundle将其注册到您的Symfony应用程序kernel中。

// app/AppKernel.php
class AppKernel extends Kernel {
    public function registerBundles() {
        $bundles = [
            // ...
            new Scribe\Teavee\HtmlGeneratorBundle\ScribeTeaveeHtmlGeneratorBundle(),
        ];
        // ...
    }
}

配置

可以使用Symfony控制台命令app/console（假设使用Symfony全栈框架和bundle注册）引用可用的配置值。此外，此包提供了一个裸控制台可执行文件，可以通过调用以下命令来执行。

bin/teavee-html-generator config:dump-reference scribe_teavee_html_generator

参考

API文档

本包的API文档可在以下地址查看：scr.be/teavee-html-generator-bundle/api（以及以下通过《参考》徽章链接，该徽章位于《其他链接》标题下）。所有API参考都是基于master Git分支构建的，并且在每次Git推送时自动更新——一旦本包成熟，将提供针对特定版本的API参考。

整个API参考网站都是使用一个快速、可靠且功能完善的CLI工具Sami自动生成的。它经过严格和定期的测试，在诸如Symfony全栈框架（scr.be/go/api-ref-symfony>）等大型复杂项目中使用，以及在其Twig（scr.be/go/api-ref-twig>）等小型项目中的应用。参考Sami的GitHub页面，了解如何将其用于自己的项目！

示例/教程

目前，除了本README之外，没有“人工编写的”文档。待包稳定且资源可用时，将发布一个包含额外信息和教程的RTD（Read the Docs）页面，其中包括在Symfony框架中的实际用例。

贡献

讨论

如果您想进行一般性咨询或讨论广泛的主题或想法，可以在Freenode上找到robfrawley。还有一个#scribe频道，可以通过以下链接加入：irc.choopa.net:6669/scribe。

问题

要报告问题或请求新功能，请使用GitHub或GitLab发起讨论。尽可能提供更多信息，以便快速解决。如果您几天内没有收到回复，请随时“ping”该主题。

代码

在您使用此包的过程中创建了额外的功能？请将其反馈给上游！不要犹豫，提交拉取请求！除了在贡献指南中概述的简要要求之外，您的想象力是唯一的限制。

许可证

本项目采用MIT许可证许可，这是一个FSF/OSI批准且与GPL兼容的许可，一个宽松的免费软件许可。请参阅随源代码一起分发的LICENSE文件以获取更多信息。

其他链接

目的	状态
稳定版本
开发版本
许可证
参考