README

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

概述

欢迎！scr-be/teavee-block-manager-bundle 软件包提供了一个可扩展的内容和资产协调器（类似CMS），提供许多功能和配置选项，同时保留简单的API。

分组

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

JTT

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

快速开始

安装

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

$ composer require scr-be/teavee-block-manager-bundle

要启用该软件包，请通过在bundle数组中实例化 ScribeTeaveeBlockManagerBundle 在你的Symfony应用程序内核中注册它。

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

配置

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

bin/teavee-block-manager config:dump-reference scribe_teavee_block_manager

参考

API文档

本包的API文档可在以下地址查看：scr.be/teavee-block-manager-bundle/api（以及下方通过“参考”徽章链接的页面）。所有API参考都是基于master Git分支构建的，并且每次Git推送都会自动更新。一旦本包成熟，将提供针对特定版本的API参考。

整个API参考网站使用一个快速、可靠且功能强大的命令行工具自动生成，名为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”该主题。

代码

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

许可

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

附加链接

目的	状态
稳定版本
开发版本
许可协议
参考信息