CHM 转 Markdown 转换器

一个用于将编译的 HTML 帮助 (CHM) 文件转换为 Markdown 格式的 Python 实用程序。此工具从 CHM 文档中提取 HTML 文件，并将它们转换为格式良好的 Markdown 文件，从而使技术文档更易于访问且更易于进行版本控制。

功能

• 使用 7-Zip 提取 CHM 文件
• 将 HTML 内容转换为干净的 Markdown 格式
• 特殊处理带有特定于语言的语法高亮显示的代码片段
• 保留和修复表格
• 更新内部链接以维护文档引用
• 异步处理文件以获得更好的性能
• 批量处理并报告进度

要求

• Python 3.7+
• 7-Zip 安装在默认位置 (C:\Program Files\7-Zip\7z.exe)
• 以下 Python 包：
  • beautifulsoup4
  • html2text
  • aiofiles

安装

1. 克隆或下载此存储库
2. 安装所需的 Python 包：

pip install -r requirements.txt

或者直接安装它们：

pip install beautifulsoup4 html2text aiofiles

用法

1. 编辑 chm_to_markdown.py 的 main() 函数中的配置变量：

input_folder = r"C:\Path\To\Extracted\Files"  # 用于提取 CHM 的临时文件夹
output_folder = r"C:\Path\To\Output\Markdown"  # Markdown 文件将保存到的位置
chm_file_path = r"C:\Path\To\Your\File.chm"    # 您的 CHM 文件路径

2. 运行脚本：

python chm_to_markdown.py

3. 脚本将：
   • 清空输入和输出文件夹
   • 将 CHM 文件提取到输入文件夹
   • 将 HTML 文件转换为 Markdown
   • 将 Markdown 文件保存到输出文件夹

性能调优

您可以调整 process_folder_async() 调用中的以下参数，以优化系统的性能：

• max_workers: 用于 CPU 密集型操作的工作线程数
• semaphore_limit: 最大并发文件 I/O 操作数
• batch_size: 每个批次中要处理的文件数

await process_folder_async(
    input_folder, output_folder, max_workers=8, semaphore_limit=20, batch_size=50
)

自定义

该脚本为内容转换提供了几个自定义选项：

删除不需要的元素

您可以通过编辑以下列表来自定义要删除的 HTML 元素：

tags_to_remove = ["iframe", "object", "script", "br", "img"]
classes_to_remove = ["collapsibleAreaRegion", "collapsibleRegionTitle", ...]
ids_to_remove = ["PageFooter"]

代码片段

该脚本处理带有特定于语言的格式的代码片段。您可以自定义语言映射：

id_to_lang = {
    "IDAB_code_Div1": "csharp",
    "IDAB_code_Div2": "vb",
    "IDAB_code_Div3": "cpp",
    "IDAB_code_Div4": "fsharp",
}

故障排除

• 缺少模块错误: 确保您已安装所有必需的软件包，并且您的 Python 环境已正确配置。
• 找不到 7-Zip: 检查 7-Zip 是否安装在默认位置，或者更新脚本中的路径。
• 权限错误: 以管理员权限运行您的终端或命令提示符。
• 大型 CHM 文件出现内存问题: 尝试增加批处理大小并减少 max_workers 以管理内存使用。

许可证

本项目是开源的，并根据 MIT 许可证提供。