README

概述

欢迎！ The src-run/cocoa-markdown-library 包提供以下功能

简单的基于PHP的Markdown转换库，支持自定义运行时和插件。

分组

我们使用Willy Wonka灵感的命名模式为我们的包组命名。此包是cocoa组的一部分，该组是关注“核心反射基类”和相关功能的包集合。

如果你手头上有太多时间，欢迎你研究一些无用的细节关于这个特定组。

JTT

此包代表了一个在大量开源代码中的单个项目，这些代码在“SR”命名空间下发布，包括许多框架无关的库、一组Symfony包以及一些单独的发布。该项目由以下人员编写和维护：

快速开始

安装

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

$ composer require src-run/cocoa-markdown-library

或者，要将此项目添加到您的"composer.json"文件中，请在"require"部分添加以下内容。

require: {
	"src-run/cocoa-markdown-library": "dev-master"
}

注意：不推荐使用"dev-master"约束。请意识到，这样做可能会允许拉入具有向后不兼容、破坏性更改的发布。相反，使用语义版本控制并显式指定要求是良好的实践。例如，要要求版本1.0，您将使用^1.0。

参考

API文档

此包的API参考可在我们的文档网站上找到（参见以下“附加链接”部分中找到的表的“参考”行）。所有API文档都会在git push事件发生时自动编译针对master分支。

计划为特定版本提供静态API参考，并在此包成熟并达到版本1里程碑时发布。.

上述API参考网站是使用称为Sami的可靠且经过良好开发的CLI工具自动生成的。它经过严格的定期测试，并用于一些大型项目，如Symfony Full-Stack Framework <see: https://src.run/go/symfony-api>，以及一些较小项目，如Twig <see: https://src.run/go/twig-api>。有关在您自己的项目中使用Sami的更多信息，请参阅Sami的存储库页面。

示例/教程

目前，除了这份README（它本身也是从模板生成的）之外，没有“人工编写的”文档。待到软件包稳定、可用工时充足以及有外部用户实际需求时，我们可能会发布一个包含官方文档、教程和额外资源的Read the Docs页面。

贡献

讨论

如果您想进行一般咨询或讨论广泛的话题或想法，请在Freenode上找到“robfrawley”。他总是乐于讨论语言级别想法、项目可能的新方向、新兴技术，以及天气情况。

问题

要报告问题或请求新功能，请使用项目问题跟踪器。在任何错误报告中包含尽可能多的信息。如果您几天内没有收到回复，可以随时“ping”该话题（有时GitHub通知电子邮件会落入缝隙）。

代码

在利用这个包的同时，您创建了额外的功能？太好了：将其提交回上游！请毫不犹豫地提交拉取请求！您的想象力和我们在CONTRIBUTING.md文件中概述的要求是唯一限制。

许可

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

src-run / cocoa-markdown-library

维护者

详细信息

README

概述

分组

JTT

快速开始

安装

参考

API文档

示例/教程

贡献

讨论

问题

代码

许可

其他链接