HTML转markdown-文档转markdownAPI介绍

前言在日常办公与系统开发过程中经常需要将 Word、HTML 等格式文档转为 Markdown 格式用于知识库、接口文档、项目说明等场景。手动转换不仅耗时费力还容易出现格式错乱、图片丢失、排版不统一等问题不同文档的标签、样式差异也会增加整理难度。为高效实现文档标准化归档本文设计文档与 HTML 转 Markdown 转换方案通过解析文档结构、过滤冗余样式标签、统一标题、表格、列表等排版规则自动完成格式转换保留原有内容结构。该转换工具可快速适配技术文档、业务资料等场景提升文档整理效率保障多平台文档格式统一便于在线查阅与版本管理。应用场景项目知识库场景将 Word、HTML 格式的需求文档、设计说明批量转为 Markdown统一文档格式方便在线知识库归档、查阅与版本管理。接口开发场景把网页版接口说明、HTML 接口文档快速转换成 Markdown 格式适配各类代码仓库、接口管理平台便于开发人员协作查阅。技术博文创作将本地 Word 稿件、网页资讯内容转换为 Markdown直接发布于技术社区、个人博客省去手动排版的繁琐操作。企业资料整理对企业规章制度、培训手册等多格式文档统一转码实现文档轻量化存储、多终端高效分享。开源项目维护把各类网页、Word 说明文档转为 Markdown用于项目 README、使用手册编写适配开源平台文档规范。API介绍请求参数名称类型必须说明appIdString是服务商分配的唯一标识。timestampLong是当前时间毫秒数。signString是签名详见签名算法说明。htmlString否待转换的 HTML 内容。html、file、url至少传一个优先级fileurlhtml。fileFile否待转换文件支持.html、.htm、.docx文件大小限制 3M 以内。Word 文件仅支持.docx不支持.doc。html、file、url至少传一个传file时优先处理文件。urlString否Word.docx文档公网地址仅支持.docx文件不支持.doc文件大小限制 3M 以内。html、file、url至少传一个仅在未传file时生效。imageModeString否图片处理模式zip图片单独解析并打包返回.zipbase64图片内嵌到 Markdown 并返回.md不传默认zip。戳这里查看详细说明返回样例{code:200,// 返回码详见code返回码说明msg:成功,// code对应的描述taskNo:193000000000000000000001,// 本次请求号charge:true,// 计费标志data:{url:https://file.jumdata.com/office/html-to-markdown/20260604/xxxxxxxx.zip// 压缩包地址内含 md 文件和图片文件}}