dotnet-mammoth 使用教程

1. 项目介绍

dotnet-mammoth 是一个用于将 .docx 文档转换为简单和干净 HTML 的 .NET 库。该项目旨在通过使用文档中的语义信息，忽略其他细节，生成简洁的 HTML 代码。它支持多种文档格式，如 Microsoft Word、Google Docs 和 LibreOffice 创建的文档。

2. 项目快速启动

安装

首先，通过 NuGet 安装 dotnet-mammoth：

Install-Package Mammoth

基本使用

以下是一个简单的示例，展示如何将 .docx 文件转换为 HTML：

using Mammoth;

class Program
{
    static void Main()
    {
        var converter = new DocumentConverter();
        var result = converter.ConvertToHtml("document.docx");
        var html = result.Value; // 生成的 HTML
        var warnings = result.Warnings; // 转换过程中的警告

        Console.WriteLine(html);
    }
}

自定义样式映射

你可以通过添加自定义样式映射来控制文档样式到 HTML 元素的转换。例如，将样式名为 Section Title 的段落转换为 <h1> 元素：

var converter = new DocumentConverter();
converter.AddStyleMap("p[style-name='Section Title'] => h1:fresh");
var result = converter.ConvertToHtml("document.docx");

3. 应用案例和最佳实践

应用案例

• 文档管理系统：在文档管理系统中，用户上传的 .docx 文件可以自动转换为 HTML 格式，以便在网页上展示。
• 内容发布平台：内容发布平台可以将用户提交的 .docx 文档转换为 HTML，以便在网站上发布。

最佳实践

• 自定义样式映射：根据项目需求，自定义样式映射以确保生成的 HTML 符合预期。
• 处理警告信息：在转换过程中，注意处理警告信息，以确保转换结果的准确性。

4. 典型生态项目

• Mammoth.js：JavaScript 版本的 Mammoth，支持浏览器和 Node.js。
• Mammoth for Python：Python 版本的 Mammoth，适用于 Python 开发者。
• Mammoth for Java/JVM：Java/JVM 版本的 Mammoth，适用于 Java 开发者。

通过这些生态项目，dotnet-mammoth 可以在不同的开发环境中使用，满足多样化的需求。