Turndown项目：在Markdown链接中保留HTML标签的方法

背景介绍

Turndown是一个流行的JavaScript库，用于将HTML转换为Markdown格式。在实际开发中，我们经常需要将HTML内容转换为Markdown，同时保留某些特定的HTML标签或自定义组件。

问题场景

在将HTML链接转换为Markdown时，开发者希望在链接文本中包含自定义的HTML标签。例如，将以下HTML：

<a href='https://www.google.com' class='LinkOut'>Go to Google</a>

转换为Markdown时，期望输出：

[Go to Google <Icon icon="fa-external-link" size="sm" />](https://www.google.com)

而不是被转义的版本：

[Go to Google <Icon icon="fa-external-link" size="sm" />](https://www.google.com)

解决方案

1. 使用自定义规则

Turndown提供了添加自定义规则的功能，我们可以创建一个专门处理特定链接的规则：

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})`;
    },
});

2. 实现原理

1. filter函数：识别需要特殊处理的节点，这里我们检查是否是<a>标签且具有特定class
2. replacement函数：定义如何转换该节点，直接返回包含HTML标签的Markdown格式

3. 注意事项

• 确保自定义HTML标签在目标Markdown解析器中能被正确处理
• 如果需要在多个地方使用这种转换，可以考虑封装成可复用的函数
• 对于更复杂的HTML结构，可能需要编写更精细的过滤和替换逻辑

高级应用

处理多种链接类型

可以扩展上述规则，处理不同类型的链接：

turndownService.addRule('enhanced-links', {
    filter: function (node) {
        return node.nodeName === 'A';
    },
    replacement: function (content, node) {
        const url = node.getAttribute("href");
        const classes = node.getAttribute("class") || '';
        
        if (classes.includes('LinkOut')) {
            return `[${content} <Icon icon="fa-external-link" size="sm" />](${url})`;
        }
        if (classes.includes('Download')) {
            return `[${content} <DownloadIcon />](${url})`;
        }
        return `[${content}](${url})`;
    },
});

性能考虑

对于大量HTML内容的转换：

1. 尽量使用简单的过滤条件
2. 避免在replacement函数中进行复杂计算
3. 考虑缓存常用转换结果

总结

通过Turndown的自定义规则功能，我们可以灵活地控制HTML到Markdown的转换过程，保留需要的HTML标签或组件。这种方法特别适用于需要在Markdown中嵌入UI组件或特殊图标的场景。开发者可以根据实际需求扩展和定制转换规则，实现更复杂的转换逻辑。