Turndown项目中使用自定义规则保留HTML标签的方法
2025-05-24 02:36:21作者:盛欣凯Ernestine
概述
在使用Turndown这个HTML转Markdown的库时,开发者有时会遇到需要保留特定HTML标签不被转义的情况。本文将详细介绍如何通过自定义规则来实现这一需求。
问题背景
在将HTML转换为Markdown的过程中,Turndown默认会将HTML标签转义为字符实体(如将<转换为<)。但在某些场景下,我们可能希望在生成的Markdown中保留某些HTML标签的原始形式。
解决方案
Turndown提供了强大的自定义规则功能,允许开发者针对特定HTML元素创建专门的转换逻辑。以下是实现保留HTML标签的具体方法:
1. 创建自定义规则
通过addRule方法可以添加自定义转换规则。每个规则需要定义两个关键部分:
filter函数:用于匹配需要应用此规则的HTML元素replacement函数:定义如何将匹配的元素转换为Markdown
2. 实现保留HTML标签
在replacement函数中,可以直接返回包含HTML标签的字符串。Turndown不会对这些在规则中明确返回的HTML标签进行转义处理。
示例代码
以下是一个完整的示例,展示如何保留<Icon>标签:
const TurndownService = require('turndown');
const turndownService = new TurndownService();
turndownService.addRule('external-link', {
filter: function (node) {
const aclass = node.getAttribute("class");
return node.nodeName === 'A' && aclass === 'LinkOut';
},
replacement: function (content, node) {
let url = node.getAttribute("href");
if (!url?.startsWith('http')) {
return content;
}
return `[${content} <Icon icon="fa-external-link" size="sm" />](${url})`;
},
});
const htmlStr = `<a href='https://www.google.com' class='LinkOut'>Go to Google</a>`;
console.log(turndownService.turndown(htmlStr));
执行上述代码将输出:
[Go to Google <Icon icon="fa-external-link" size="sm" />](https://www.google.com)
注意事项
-
标签匹配:确保
filter函数能够准确匹配到目标元素,避免规则应用到不需要的元素上。 -
URL验证:如示例所示,建议对链接进行验证(如检查是否以'http'开头),以确保只转换符合条件的链接。
-
自定义标签:Turndown不会对自定义标签(如
<Icon>)进行特殊处理,因此可以直接在输出字符串中包含这些标签。 -
Markdown兼容性:虽然可以在Markdown中嵌入HTML,但要注意目标渲染器是否支持这些HTML标签。
进阶用法
对于更复杂的需求,可以在replacement函数中实现更精细的控制:
- 根据元素属性动态生成不同的HTML标签
- 组合多个HTML标签
- 添加条件逻辑来决定是否包含特定标签
总结
通过Turndown的自定义规则功能,开发者可以灵活控制HTML到Markdown的转换过程,包括保留特定的HTML标签。这种方法既保持了Markdown的简洁性,又能在需要时嵌入HTML以实现更丰富的展示效果。
登录后查看全文
热门项目推荐
相关项目推荐
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00- DDeepSeek-OCR暂无简介Python00
openPangu-Ultra-MoE-718B-V1.1昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00
HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00
AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03
Spark-Scilit-X1-13BFLYTEK Spark Scilit-X1-13B is based on the latest generation of iFLYTEK Foundation Model, and has been trained on multiple core tasks derived from scientific literature. As a large language model tailored for academic research scenarios, it has shown excellent performance in Paper Assisted Reading, Academic Translation, English Polishing, and Review Generation, aiming to provide efficient and accurate intelligent assistance for researchers, faculty members, and students.Python00
GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile013
Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
项目优选
收起
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
239
2.37 K
deepin linux kernel
C
24
6
React Native鸿蒙化仓库
JavaScript
216
291
暂无简介
Dart
539
118
仓颉编译器源码及 cjdb 调试工具。
C++
115
86
仓颉编程语言运行时与标准库。
Cangjie
122
97
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
999
589
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
589
116
Ascend Extension for PyTorch
Python
78
111
仓颉编程语言提供了 stdx 模块,该模块提供了网络、安全等领域的通用能力。
Cangjie
80
56