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

要启用扩展包，通过在扩展包数组中实例化 ScribeTeaveeScribbleDownBundle 来在您的 Symfony 应用程序内核中注册它。

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

附加链接

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