binarytorch/phpdown

此包已被废弃,不再维护。未建议替代包。

代码驱动的PHP Markdown表示

v1.0 2019-07-20 07:56 UTC

This package is auto-updated.

Last update: 2024-02-20 18:48:40 UTC


README

68747470733a2f2f706870646f776e2e62696e617279746f7263682e636f6d2e6d792f696d616765732f706870646f776e2d6c6f676f2e706e67

代码驱动的PHP Markdown表示

License Release License



overview

PHPDown

为什么?(可选)

我知道,将Markdown元素表示为PHP类有点奇怪,但让我告诉你背后的原因。

目前,我仍在积极维护我的包 Larecipe,其主要目的是编写非常优雅和美观的软件文档。然而,在我作为软件开发团队领导人的日常工作中,我需要为我们的项目和API编写大量的文档,现在我感到我必须自动化这个过程,节省时间去做其他更重要的事情。

因此,我决定开发一个新的开源工具(即将推出),它将为Larecipe提供文档生成功能,您可以从测试套件中实时生成文档,而无需每次添加或删除字段时都更新文档。这个想法需要生成Markdown输出,所以!你可以猜到故事的其余部分😆,但我真的认为这对其他情况很有帮助,这就是为什么我将它作为一个新的PHP包分开。

安装

您可以通过composer安装此包

composer require binarytorch/phpdown

用法和受支持元素

  • 标题
  • 换行
  • 引用块
  • 链接
  • 图片
  • 待办事项列表
  • 突变:[删除线、粗体、内联代码、标记]
  • 代码
  • 表格
  • Markdown文档

查看完整文档

贡献

有关详细信息,请参阅CONTRIBUTING

安全

如果您发现任何安全相关的问题,请通过电子邮件saleem@binarytorch.com.my联系,而不是使用问题跟踪器。

致谢

许可证

MIT许可证(MIT)。有关更多信息,请参阅许可证文件