📋 核心功能解析

Mammoth.js是一款专注于.docx文档转HTML的JavaScript工具。它通过识别文档中的语义信息，将Word文档转换为简洁干净的HTML格式。

💡 核心价值：

• 专注语义转换而非样式复制，生成结构化HTML
• 支持自定义样式映射，灵活适配各类文档规范
• 轻量级设计，无冗余依赖，浏览器与Node.js环境均适用

⚠️ 重要提示：本项目采用BSD-2-Clause许可证，允许商业使用，但需保留原作者版权声明。

🗺️ 项目地图

项目采用模块化架构设计，关键目录功能如下：

核心代码区（lib/）

• docx/：解析.docx文件结构的核心模块
• html/：HTML生成与简化处理
• styles/：样式映射与转换规则
• writers/：HTML与Markdown输出器

演示与测试区

• browser-demo/：浏览器环境演示页面
• test/：单元测试与测试数据
• test-data/：各类测试用例文档

🚀 快速上手：闯关式启动指南

第一关：环境准备

1. 克隆项目代码库

   git clone https://gitcode.com/gh_mirrors/ma/mammoth.js
   

2. 进入项目目录

   cd mammoth.js
   

3. 安装依赖

   npm install
   

第二关：启动演示

1. 构建项目

   make setup
   

2. 启动浏览器演示

   open browser-demo/index.html
   

第三关：验证安装

• 页面应显示文件上传区域
• 尝试上传test-data/single-paragraph.docx
• 验证是否成功转换为HTML内容

💼 实际应用场景

场景1：内容管理系统集成

const mammoth = require("mammoth");
const fs = require("fs");
// 读取Word文档并转换为HTML
mammoth.convertToHtml({path: "user-upload.docx"})
  .then(result => {
    // 保存转换后的HTML到数据库
    saveToDatabase(result.value);
  })
  .catch(error => {
    console.error("转换失败:", error);
  });

场景2：自定义样式映射

// 将文档中的"警告"样式映射为带类名的div
const options = {
  styleMap: [
    "p[style-name='警告'] => div.warning:fresh",
    "p[style-name='提示'] => div.tip:fresh"
  ]
};
mammoth.convertToHtml({path: "guide.docx"}, options);

场景3：图片处理与保存

// 自定义图片处理函数
const options = {
  convertImage: mammoth.images.imgElement(image => {
    return image.readAsBase64String().then(base64 => {
      // 保存图片到文件系统并返回URL
      const imageUrl = saveImage(base64, image.contentType);
      return {src: imageUrl};
    });
  })
};
mammoth.convertToHtml({path: "report-with-images.docx"}, options);

⚙️ 场景配置矩阵

应用场景	关键配置选项	代码示例片段
基础转换	默认配置	mammoth.convertToHtml({path: "doc.docx"})
样式定制	styleMap	styleMap: ["p[style-name='Title'] => h1:fresh"]
图片外存	convertImage	自定义图片处理函数
纯文本提取	extractRawText	mammoth.extractRawText({path: "doc.docx"})
忽略默认样式	includeDefaultStyleMap	includeDefaultStyleMap: false

❓ 常见问题

Q: 转换后的HTML样式与原文档差异大？
A: Mammoth专注语义转换而非样式复制。可通过styleMap自定义映射规则，或使用CSS美化输出结果。

Q: 图片无法正确显示？
A: 默认配置将图片转为base64内联。大文件建议使用--output-dir选项将图片保存为文件。

Q: 表格转换格式错乱？
A: 复杂表格可能需要后处理。可尝试使用HTML简化选项：mammoth.convertToHtml(input, {simplifyHtml: true})

📌 使用建议

1. 对于需要精确样式还原的场景，建议配合自定义CSS使用
2. 处理用户上传文件时，务必验证文件类型和大小
3. 复杂文档转换前，建议先进行格式清理，移除冗余样式
4. 批量处理时，考虑使用stream模式减少内存占用

Mammoth.js虽不追求100%样式还原，但在内容迁移、文档发布等场景下提供了高效可靠的转换能力。通过合理配置，可满足大多数Web内容管理需求。