HTML 转 Markdown for PHP 技术文档

1. 安装指南

环境要求

• PHP 7.2 及以上版本

安装步骤

1. 使用 Composer 安装库：

   composer require league/html-to-markdown
   

2. 在脚本顶部添加自动加载文件：

   require 'vendor/autoload.php';
   

2. 项目使用说明

基本用法

1. 创建 HtmlConverter 实例：

   use League\HTMLToMarkdown\HtmlConverter;
   
   $converter = new HtmlConverter();
   

2. 将 HTML 代码传递给 convert() 函数：

   $html = "<h3>Quick, to the Batpoles!</h3>";
   $markdown = $converter->convert($html);
   

3. 输出转换后的 Markdown 内容：

   echo $markdown; // 输出: ### Quick, to the Batpoles!
   

示例

项目中包含一个 demo 目录，其中有一个 HTML 转 Markdown 的转换表单，可以用来测试。

3. 项目 API 使用文档

转换选项

• strip_tags: 设置为 true 时，会去除没有 Markdown 等效的 HTML 标签，但保留其内容。

  $converter = new HtmlConverter(array('strip_tags' => true));
  $html = '<span>Turnips!</span>';
  $markdown = $converter->convert($html); // 输出: Turnips!
  

• remove_nodes: 指定要去除的标签及其内容。

  $converter = new HtmlConverter(array('remove_nodes' => 'span div'));
  $html = '<span>Turnips!</span><div>Monkeys!</div>';
  $markdown = $converter->convert($html); // 输出: ""
  

• preserve_comments: 保留注释内容。

  $converter = new HtmlConverter(array('preserve_comments' => true));
  $html = '<span>Turnips!</span><!-- Monkeys! -->';
  $markdown = $converter->convert($html); // 输出: Turnips!<!-- Monkeys! -->
  

样式选项

• bold_style: 设置加粗标签的样式。
• italic_style: 设置斜体标签的样式。

  $converter = new HtmlConverter();
  $converter->getConfig()->setOption('italic_style', '*');
  $converter->getConfig()->setOption('bold_style', '__');
  $html = '<em>Italic</em> and a <strong>bold</strong>';
  $markdown = $converter->convert($html); // 输出: *Italic* and a __bold__
  

换行选项

• hard_break: 设置为 true 时，br 标签转换为 GitHub Flavored Markdown 风格的换行。

  $converter = new HtmlConverter();
  $html = '<p>test<br>line break</p>';
  $converter->getConfig()->setOption('hard_break', true);
  $markdown = $converter->convert($html); // 输出: test\nline break
  

自动链接选项

• use_autolinks: 设置为 false 时，始终使用完整链接语法。

  $converter = new HtmlConverter();
  $html = '<p><a href="https://thephpleague.com">https://thephpleague.com</a></p>';
  $converter->getConfig()->setOption('use_autolinks', false);
  $markdown = $converter->convert($html); // 输出: [https://thephpleague.com](https://thephpleague.com)
  

自定义环境对象

• 可以通过传递自定义的 Environment 对象来定制转换器。

  $environment = new Environment(array(
      // 配置
  ));
  $environment->addConverter(new HeaderConverter());
  $converter = new HtmlConverter($environment);
  

表格支持

• 默认不支持 Markdown 表格，需要显式添加 TableConverter。

  use League\HTMLToMarkdown\Converter\TableConverter;
  $converter->getEnvironment()->addConverter(new TableConverter());
  

4. 项目安装方式

通过 Composer 安装

composer require league/html-to-markdown

手动安装

1. 下载项目源码。
2. 将 src 目录中的文件复制到你的项目中。
3. 在脚本中引入自动加载文件：

   require 'path/to/vendor/autoload.php';
   

通过以上步骤，你可以成功安装并使用 HTML To Markdown for PHP 项目。