Marked.js 实现严格保留换行符的解决方案

背景介绍

Marked.js 是一个流行的 Markdown 解析器，但在处理换行符时遵循了 CommonMark 规范，即默认情况下会将连续的两个换行符转换为段落分隔，而单个换行符则会被忽略。这种处理方式符合标准 Markdown 规范，但在某些特殊场景下，开发者可能需要严格保留文档中的所有换行符。

问题分析

标准的 Marked.js 配置中，即使启用了 breaks 选项，也只能将单个换行符转换为 <br> 标签，而无法处理多个连续换行符的情况。此外，breaks 选项与段落标记 <p> 的生成机制存在交互，导致无法完全按照原始文档的换行结构输出 HTML。

技术解决方案

自定义扩展实现

通过创建 Marked.js 的自定义扩展，我们可以实现对换行符的精确控制。以下是完整的实现方案：

import { Marked } from 'marked';

// 定义换行处理扩展
const newlineBreaksExtension = {
  name: 'newlineBreaks',
  start(src) { return src.indexOf('\n'); },
  tokenizer(src) {
    const match = src.match(/^\n+/);
    if (match) {
      return {
        type: 'newlineBreaks',
        raw: match[0],
        text: match[0],
      };
    }
  },
  renderer(token) {
    return token.text.replace(/\n/g, '<br>\n');
  },
};

// 配置扩展为块级和行内两种级别
const newlineBreaks = {
  extensions: [
    {
      ...newlineBreaksExtension,
      level: 'block',
    },
    {
      ...newlineBreaksExtension,
      level: 'inline',
    },
  ],
};

// 创建配置好的 Marked 实例
const marked = new Marked(newlineBreaks);

CSS 辅助调整

为了确保输出效果符合预期，还需要添加以下 CSS 规则：

p {
  display: inline;
}

这段 CSS 会阻止 Marked.js 自动生成的 <p> 标签创建新的块级上下文，使所有内容保持在同一流中，配合 <br> 标签实现精确的换行控制。

实现原理

1. 扩展机制：Marked.js 的扩展系统允许我们介入解析过程的各个阶段
2. 双级别处理：同时配置块级和行内扩展确保捕获所有位置的换行符
3. 正则匹配：使用简单的正则表达式识别连续的换行符序列
4. 精确替换：在渲染阶段将每个换行符转换为 <br> 标签

注意事项

1. 此方案会保留代码块内的换行符不变，符合预期行为
2. 连续多个换行符会被转换为对应数量的 <br> 标签
3. 需要配合 CSS 调整才能达到最佳视觉效果
4. 此方案不会影响其他 Markdown 元素的正常解析

总结

通过自定义扩展和简单的 CSS 调整，我们成功实现了在 Marked.js 中严格保留所有换行符的需求。这种方案既保持了 Marked.js 的核心功能，又满足了特殊场景下的格式要求，展示了 Marked.js 扩展系统的强大灵活性。