PHP Markdown技术文档

安装指南

要使用PHP Markdown库，您需要确保您的环境满足以下要求：

1. PHP版本7.4或更高版本。
2. 如果您没有使用自动加载功能，可能需要将pcre.backtrack_limit设置为高于1,000,000（默认值通常足够）。

使用Composer安装

推荐使用Composer来管理和安装PHP Markdown库。您可以通过以下命令安装：

$ composer require michelf/php-markdown

不使用自动加载

如果您无法使用类自动加载，您也可以通过include或require来直接访问解析器。例如：

require_once 'Michelf/Markdown.inc.php';

或者，如果您需要MarkdownExtra解析器：

require_once 'Michelf/MarkdownExtra.inc.php';

项目使用说明

基本使用

使用Composer安装后，您需要包含Composer生成的vendor/autoload.php文件以启用自动加载：

require 'vendor/autoload.php';

然后，您可以这样使用：

use Michelf\Markdown;
$my_html = Markdown::defaultTransform($my_text);

对于MarkdownExtra，使用方法相同：

use Michelf\MarkdownExtra;
$my_html = MarkdownExtra::defaultTransform($my_text);

定制解析器配置

如果您需要自定义解析器配置，可以实例化解析器并更改一些配置变量：

use Michelf\MarkdownExtra;
$parser = new MarkdownExtra;
$parser->fn_id_prefix = "post22-";
$my_html = $parser->transform($my_text);

项目API使用文档

公共API

• Markdown 和 MarkdownExtra 类
• 构造函数
• transform 和 defaultTransform 函数
• 配置变量

版本政策

版本号格式为 主要版本.次要版本.补丁。主要版本号表示不兼容的API更改，次要版本号表示新功能的添加，补丁号表示小的错误修复或改进。

配置变量

配置变量允许您自定义解析器的行为。例如：

$parser->fn_id_prefix = "post22-";

保护成员

保护成员不是公共API的一部分，不应在公共代码中使用。

项目安装方式

使用Composer

推荐使用Composer来安装和管理PHP Markdown库。安装后，您可以通过自动加载功能方便地使用库中的类和函数。

不使用自动加载

如果您无法使用自动加载，您可以通过include或require直接访问解析器。例如：

require_once 'Michelf/Markdown.inc.php';

或者，如果您需要MarkdownExtra解析器：

require_once 'Michelf/MarkdownExtra.inc.php';

希望这份技术文档能够帮助您更好地使用PHP Markdown库！