前端渲染 Markdown 格式：主流库选型与实战

// 1. 获取 DOM 元素
const input = document.getElementById('markdownInput');
const preview = document.getElementById('previewArea');

// 2. 配置 marked（启用代码高亮）
marked.setOptions({
  highlight: (code, lang) => {
    // 若指定语言且 highlight 支持，则高亮；否则默认处理
    return lang && hljs.getLanguage(lang) ? hljs.highlight(code, { language: lang }).value : hljs.highlightAuto(code).value;
  },
  breaks: true, // 支持换行符（\n）转换为<br>
  gfm: true // 支持 GitHub Flavored Markdown（如表格、删除线）
});

// 3. 渲染函数：将 Markdown 转为 HTML 并插入预览区
function renderMarkdown() {
  const markdownText = input.value;
  const html = marked.parse(markdownText); // 核心解析方法
  preview.innerHTML = html;
}

// 4. 初始化渲染 + 监听输入变化
renderMarkdown();
input.addEventListener('input', renderMarkdown);

/* 基础样式：避免排版混乱 */
.container { display: flex; gap: 20px; margin: 20px; }
#markdownInput { width: 40%; height: 500px; padding: 10px; }
#previewArea { width: 50%; padding: 10px; border: 1px solid #eee; }
/* 配合 highlight.js 的代码块样式 */
pre code { display: block; padding: 10px; background: #1e1e1e; color: #fff; border-radius: 4px; }

步骤 3：进阶配置（自定义渲染）

若需修改默认渲染规则（如自定义标题标签、链接跳转方式），可通过 marked.Renderer() 实现：

// 自定义渲染器
const renderer = new marked.Renderer();

// 示例 1：将<h1>标题改为带 class 的<h1>
renderer.heading = (text, level) => {
  return `<h${level} class="custom-heading">${text}</h${level}>`;
};

// 示例 2：所有链接默认新窗口打开（添加 target="_blank"）
renderer.link = (href, title, text) => {
  const titleAttr = title ? `title="${title}"` : '';
  return `<a href="${href}" ${titleAttr} target="_blank" rel="noopener">${text}</a>`;
};

// 使用自定义渲染器
const html = marked.parse(markdownText, { renderer });

2. React-Markdown：React 生态专用（安全无 XSS）

如果是 React 项目，推荐使用 react-markdown（而非直接用 marked+innerHTML，避免 XSS 风险）。它基于组件化思想，支持插件扩展，且默认过滤危险 HTML。

步骤 1：安装依赖

npm install react-markdown @types/react-markdown highlight.js --save
# 若需支持表格、公式等，需安装对应插件
npm install remark-gfm remark-math rehype-katex --save

步骤 2：React 组件示例（支持代码高亮 + 表格 + 公式）

import React, { useState } from 'react';
import ReactMarkdown from 'react-markdown';
// 插件：支持 GitHub 样式（表格、删除线）、数学公式
import remarkGfm from 'remark-gfm';
import remarkMath from 'remark-math';
import rehypeKatex from 'rehype-katex';
// 代码高亮样式
import 'highlight.js/styles/github-light.min.css';
// 公式样式（需引入 katex.css）
import 'katex/dist/katex.min.css';

const MarkdownPreview = () => {
  // 初始 Markdown 内容（可替换为接口请求的数据）
  const [markdownText, setMarkdownText] = useState(`# React-Markdown 示例
## 1. 表格（需 remark-gfm 插件）
| 姓名 | 技术栈 |
|------|--------|
| 张三 | React |
| 李四 | Vue |
## 2. 代码块（自动高亮）
\`\`\`javascript
// React 组件示例
function App() {
  return <h1>Hello Markdown</h1>;
}
\`\`\`
## 3. 数学公式（需 remark-math+rehype-katex）
欧拉公式：$e^{iπ} + 1 = 0$
`);

  return (
    <div style={{ display: 'flex', gap: '20px', padding: '20px' }}>
      {/* 输入区 */}
      <textarea
        value={markdownText}
        onChange={(e) => setMarkdownText(e.target.value)}
        style={{ width: '40%', height: '600px', padding: '10px' }}
      />
      {/* 预览区：核心组件 ReactMarkdown */}
      <ReactMarkdown
        className="markdown-body"
        // 可配合 github-markdown-css 美化
        remarkPlugins={[remarkGfm, remarkMath]} // Markdown 语法扩展插件
        rehypePlugins={[rehypeKatex]} // HTML 处理插件（公式渲染）
        style={{ width: '50%', padding: '20px', border: '1px solid #eee' }}
      >
        {markdownText}
      </ReactMarkdown>
    </div>
  );
};

export default MarkdownPreview;

关键优势：

• 安全：默认不渲染 script、iframe 等危险标签，无需手动处理 XSS；
• 插件化：通过 remark-（Markdown 语法扩展）和 rehype-（HTML 处理）插件支持复杂功能；
• TS 友好：自带类型定义，避免类型报错。

3. showdown.js：功能全面（适合复杂场景）

showdown.js 是另一个成熟的 Markdown 解析库，支持更多自定义配置（如自动链接、缩写），适合需要高度定制的场景（如企业级文档系统）。

基础使用示例（Vue 项目）：

<template>
  <div class="markdown-container">
    <textarea v-model="markdownText" @input="render" placeholder="输入 Markdown..."></textarea>
    <div v-html="htmlContent"></div>
  </div>
</template>

<script setup>
import { ref, onMounted } from 'vue';
import showdown from 'showdown';
import 'highlight.js/styles/atom-one-light.css';
import hljs from 'highlight.js';

// 初始化 showdown 转换器
const converter = new showdown.Converter({
  tables: true, // 支持表格
  strikethrough: true, // 支持删除线（~~文本~~）
  autolink: true, // 自动识别链接（无需 []()）
  extensions: [
    // 自定义扩展：代码高亮
    () => {
      return {
        type: 'output',
        filter: (html) => {
          // 匹配<pre><code>标签，对代码块高亮
          return html.replace(
            /<pre><code([^>]*)>/g,
            (match, attrs) => `<pre><code${attrs}>`,
          ).replace(
            /<code([^>]*)>([\s\S]*?)<\/code>/g,
            (match, attrs, code) => {
              const langMatch = attrs.match(/class="language-(\w+)"/);
              const lang = langMatch ? langMatch[1] : 'plaintext';
              const highlighted = hljs.highlight(code, { language: lang }).value;
              return `<code${attrs}>${highlighted}</code>`;
            },
          );
        },
      };
    },
  ],
});

const markdownText = ref('# Showdown Vue 示例\n**加粗文本**\n`const a = 1`');
const htmlContent = ref('');

// 渲染函数
const render = () => {
  htmlContent.value = converter.makeHtml(markdownText.value);
};

// 初始化渲染
onMounted(() => render());
</script>

<style scoped>
.markdown-container { display: flex; gap: 20px; padding: 20px; }
textarea { width: 40%; height: 500px; padding: 10px; }
.preview { width: 50%; padding: 10px; border: 1px solid #eee; }
pre code { padding: 10px; border-radius: 4px; }
</style>

三、渲染优化与注意事项

1. 解决 XSS 安全风险

直接使用 innerHTML（如 marked + 原生 JS）可能导致 XSS 攻击（如输入 ）。

解决方案：

• 用 DOMPurify 净化 HTML（适合原生 JS/showdown）：

npm install dompurify --save

import DOMPurify from 'dompurify';

// 解析后先净化，再插入 DOM
const html = marked.parse(markdownText);
const safeHtml = DOMPurify.sanitize(html); // 过滤危险标签/属性
preview.innerHTML = safeHtml;

• React 项目优先用 react-markdown（默认安全），Vue 项目可配合 vue-dompurify-html 指令。

2. 样式美化：复用成熟 CSS 库

手动写 Markdown 样式繁琐，推荐直接引入现成样式库，实现'GitHub 风格''知乎风格'等排版：

• github-markdown-css（最常用）：

<!-- CDN 引入 -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/github-markdown-css/github-markdown.min.css">

使用时给预览区添加 markdown-body 类：

<div class="markdown-body"></div>

• 其他可选：gitlab-markdown.css（GitLab 风格）、zhihu-markdown.css（知乎风格）。

3. 大文档渲染性能优化

若渲染超长 Markdown（如万字文档），可能导致页面卡顿。优化方案：

• 分片渲染：只渲染当前可视区域内容（可配合 react-window/vue-virtual-scroller）；
• 懒加载图片：解析 Markdown 中的图片链接，替换为懒加载格式（如 loading="lazy"）；
• 缓存解析结果：对相同的 Markdown 文本，缓存解析后的 HTML，避免重复解析。

四、常见场景选型建议

五、总结

前端渲染 Markdown 的核心是'选对库 + 做好配置'：

1. 简单场景用 marked.js 快速实现，React 项目优先 React-Markdown；
2. 需复杂扩展（如公式、表格）时，搭配对应的插件（remark-gfm/rehype-katex）；
3. 始终关注安全（XSS）和性能（大文档优化），避免直接使用未净化的 innerHTML；
4. 样式美化优先复用成熟 CSS 库，减少重复开发。

掌握这些方法后，你可以轻松实现 Markdown 预览、在线编辑器、文档系统等功能，提升前端项目的内容展示体验。