Rust HTML转Markdown库html2md的使用，高效实现网页内容与轻量级标记语言的转换

HTML2MD

这是一个将简单HTML文档转换为Markdown格式的库。实现了Markdown标准规范。

特性

当前支持的功能：

• 列表（包括嵌套列表）
• 标题
• 引用（包括嵌套引用）
• 段落
• 水平分割线
• 图片和链接
• 表格
• 格式化（粗体、斜体、删除线、下划线）
• 代码块

限制

• 不支持Markdown的变体风格（如-/+无序列表样式，##/==标题等）
• 还不能自动检测代码风格

使用的库

html5ever - Servo引擎的HTML解析库，用于将HTML输入转换为DOM

regex - Rust的PCRE支持，用于修正空白字符

安装

安装为命令行工具

cargo install html2md

安装为库

在项目目录中运行以下Cargo命令：

cargo add html2md

或者在Cargo.toml中添加：

html2md = "0.2.15"

完整使用示例

use html2md::parse_html;

fn main() {
    let html = r#"
        <h1>这是标题</h1>
        <p>这是一个段落，包含<strong>粗体</strong>和<em>斜体</em>文本。</p>
        <ul>
            <li>列表项1</li>
            <li>列表项2</li>
        </ul>
        <blockquote>这是一个引用</blockquote>
    "#;
    
    let markdown = parse_html(html);
    println!("{}", markdown);
}

输出结果：

这是标题

这是一个段落，包含粗体和斜体文本。

• 列表项1
• 列表项2

这是一个引用

## 更完整的示例代码

```rust
use html2md::parse_html;
use std::fs;

fn main() {
    // 示例1: 基本HTML转换
    let basic_html = r#"
        <div>
            <h2>HTML转Markdown示例</h2>
            <p>这是一个<u>完整</u>的示例，展示<del>各种</del> <strong>HTML</strong> <em>元素</em>的转换</p>
            <hr>
            <pre><code>fn main() {
    println!("Hello World");
}</code></pre>
        </div>
    "#;
    
    let basic_md = parse_html(basic_html);
    println!("基本示例输出:\n{}", basic_md);

    // 示例2: 从文件读取HTML并转换
    if let Ok(html_content) = fs::read_to_string("example.html") {
        let file_md = parse_html(&html_content);
        println!("\n文件示例输出:\n{}", file_md);
    } else {
        eprintln!("无法读取example.html文件");
    }

    // 示例3: 复杂HTML结构
    let complex_html = r#"
        <article>
            <h3>复杂结构示例</h3>
            <table>
                <thead>
                    <tr><th>Name</th><th>Age</th></tr>
                </thead>
                <tbody>
                    <tr><td>Alice</td><td>25</td></tr>
                    <tr><td>Bob</td><td>30</td></tr>
                </tbody>
            </table>
            <ol>
                <li>第一项</li>
                <li>第二项
                    <ul>
                        <li>嵌套项A</li>
                        <li>嵌套项B</li>
                    </ul>
                </li>
            </ol>
            <blockquote>
                <p>嵌套引用</p>
                <blockquote>更深层的引用</blockquote>
            </blockquote>
        </article>
    "#;
    
    let complex_md = parse_html(complex_html);
    println!("\n复杂示例输出:\n{}", complex_md);
}

贡献

您可以创建合并请求或在这里提交bug/改进问题，或者通过电子邮件发送格式化的补丁。详情请参见仓库中的CONTRIBUTING.md文件。

许可证

Copyright (C) 2018-2019  Oleg `Kanedias` Chernovskiy

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

关于双重许可的特殊条款请参见COPYING.md。