首页
学习
活动
专区
圈层
工具
发布
社区首页 >专栏 >HTML转markdown-文档转markdownAPI介绍

HTML转markdown-文档转markdownAPI介绍

原创
作者头像
聚美智数
发布2026-06-18 16:49:23
发布2026-06-18 16:49:23
1790
举报

前言

在日常办公与系统开发过程中,经常需要将 Word、HTML 等格式文档转为 Markdown 格式,用于知识库、接口文档、项目说明等场景。手动转换不仅耗时费力,还容易出现格式错乱、图片丢失、排版不统一等问题,不同文档的标签、样式差异也会增加整理难度。 为高效实现文档标准化归档,本文设计文档与 HTML 转 Markdown 转换方案,通过解析文档结构、过滤冗余样式标签、统一标题、表格、列表等排版规则,自动完成格式转换,保留原有内容结构。该转换工具可快速适配技术文档、业务资料等场景,提升文档整理效率,保障多平台文档格式统一,便于在线查阅与版本管理。

应用场景

项目知识库场景:将 Word、HTML 格式的需求文档、设计说明批量转为 Markdown,统一文档格式,方便在线知识库归档、查阅与版本管理。 接口开发场景:把网页版接口说明、HTML 接口文档快速转换成 Markdown 格式,适配各类代码仓库、接口管理平台,便于开发人员协作查阅。 技术博文创作:将本地 Word 稿件、网页资讯内容转换为 Markdown,直接发布于技术社区、个人博客,省去手动排版的繁琐操作。 企业资料整理:对企业规章制度、培训手册等多格式文档统一转码,实现文档轻量化存储、多终端高效分享。 开源项目维护:把各类网页、Word 说明文档转为 Markdown,用于项目 README、使用手册编写,适配开源平台文档规范。

API介绍

请求参数

名称

类型

必须

说明

appId

String

服务商分配的唯一标识。

timestamp

Long

当前时间毫秒数。

sign

String

签名,详见签名算法说明。

html

String

待转换的 HTML 内容。html、file、url 至少传一个;优先级:file > url > html。

file

File

待转换文件,支持 .html、.htm、.docx,文件大小限制 3M 以内。Word 文件仅支持 .docx,不支持 .doc。html、file、url 至少传一个;传 file 时优先处理文件。

url

String

Word .docx 文档公网地址,仅支持 .docx 文件,不支持 .doc,文件大小限制 3M 以内。html、file、url 至少传一个;仅在未传 file 时生效。

imageMode

String

图片处理模式:zip 图片单独解析并打包返回 .zip;base64 图片内嵌到 Markdown 并返回 .md;不传默认 zip。

返回样例

代码语言:javascript
复制
{
  "code": 200,// 返回码,详见code返回码说明
  "msg": "成功",// code对应的描述
  "taskNo": "193000000000000000000001",// 本次请求号
  "charge": true,// 计费标志
  "data": {
    "url": "https://file.jumdata.com/office/html-to-markdown/20260604/xxxxxxxx.zip"// 压缩包地址,内含 md 文件和图片文件
  }
}

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 前言
  • 应用场景
  • API介绍
    • 请求参数
    • 返回样例
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档