README

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

概述

欢迎！scr-be/teavee-scribble-down-bundle 包提供了一个基于Markdown的渲染引擎，并具有额外功能。

分组

此包是teavee组的一部分（解释），该组包括其他发布的内容，侧重于媒体、HTML、内容、生成器和相关功能。

JTT

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

快速入门

安装

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

$ composer require scr-be/teavee-scribble-down-bundle

要启用此捆绑包，请在Symfony应用程序内核中通过在捆绑数组中实例化ScribeTeaveeScribbleDownBundle来注册它。

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

配置

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

bin/teavee-scribble-down config:dump-reference scribe_teavee_scribble_down

参考

API文档

此包的API文档可在scr.be/teavee-scribble-down-bundle/api找到（以及以下通过“参考”徽章在“其他链接”标题下找到的链接）。所有API参考都是针对master Git分支构建的，并在每次Git推送时自动更新——一旦此包成熟，将提供特定版本的API参考。

整个API参考网站使用名为Sami的快速、可靠且功能完善的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文件以获取更多信息。

附加链接

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