README

这是 Michel Fortin 的原始 PHP Markdown 的更新和精简版本。与 PSR-0 自动加载器配合良好，并且对 Composer 友好。

此项目已被弃用

感谢您对此包的贡献兴趣。遗憾的是，我计划不再维护此包。

此包的原始目的是在 Packagist 上提供一个获取 Michel Fortin 的 PHP Markdown 库 PSR-0 和 Composer 友好版本的途径。Michel 最初对 Composer 没有兴趣，不想进行更改，并表示我可以自由地分叉并维护一个特殊的 Composer 包。

2013 年 1 月（或大约那时），Michel 最终加入了 Composer 阵营。更多详情请见 此处。这意味着此移植存在的主要原因（成为一个 Composer 友好的移植）实际上已经不存在了。这与 PHP Markdown 的 1.3 版本发布相对应。

此外，还出现了其他版本的 PHP Markdown 解析器，并且相当不错。

请随意继续使用它，但如果您正在启动一个新项目，我建议寻找另一个库。如果您已经有一个依赖此包的项目，我建议计划迁移到一个维护得更好的库。

感谢您多年来对这项支持和使用这个库。

与官方 PHP Markdown & Extra 的变更

更新 PHP Markdown & Extra 的初始尝试保留了代码的核心部分，但对其组织和命名的更改相当大。这实际上使此包成为从 Markdown 1.0.1n 和 MarkdownExtra 1.2.4 的硬分叉。

以下方式进行了更新

• 将解析器类移动到它们自己的文件中
• 使用 PHP 5.3 命名空间
• 遵循 PSR-0 标准
• 将 @define 配置变量替换为类 const 变量
• 与 Travis CI 集成
• 对 Composer 友好

以下方式进行了精简

• 不再包含内嵌的插件代码（WordPress、bBlog 等）
• 不再有顶级函数调用（如 Markdown() 等）

最后同步于

• PHP Markdown v1.0.1o
• PHP Markdown Extra v1.2.5

要求

• PHP 5.3+

安装

要将此包添加为本地项目依赖项，只需将 dflydev/markdown 依赖项添加到项目的 composer.json 文件中。以下是一个定义此包版本 1.0 依赖项的最小 composer.json 文件示例

{
    "require": {
        "dflydev/markdown": "1.0.*"
    }
}

使用方法

标准 Markdown（详情）解析器的简单使用

<?php
use dflydev\markdown\MarkdownParser;

$markdownParser = new MarkdownParser();

// Will return <h1>Hello World</h1>
$markdownParser->transformMarkdown("#Hello World");

Markdown Extra（详情）解析器的简单使用

<?php
use dflydev\markdown\MarkdownExtraParser;

$markdownParser = new MarkdownExtraParser();

// Will return <h1>Hello World</h1>
$markdownParser->transformMarkdown("#Hello World");

许可证

本库采用新 BSD 许可证授权 - 详细信息请参阅 LICENSE 文件。

社区

如果您有问题或想帮忙，请加入 irc.freenode.net 上的 #dflydev 频道。

不是原创

原始的 PHP Markdown 非常出色，但使用起来并不像在现代 PHP 应用程序中那样简单。在开始使用 Composer 对几个需要转换 Markdown 的新应用程序进行处理后，我决定修改和更新原始 PHP Markdown，使其更易于由 Composer 等工具管理。

本库所有初始工作（从代码中可以看出工作量相当大）都是由 Michel Fortin 在从 Perl 迁移到 PHP 的原始版本中完成的。

如果您不需要通过 Composer 安装 PHP Markdown，或者需要利用 PSR-0 自动加载，我建议您继续使用官方版本，这可能是更稳定且更广泛使用的原始 PHP Markdown。