Ant Design Pro 集成 Markdown 编辑器教程

在Ant Design Pro项目中嵌入Markdown编辑器的方法有三种：1. 使用react-markdown-editor-lite快速接入，该组件轻量且功能齐全，支持实时预览、语法高亮，适合大多数项目；2. 使用CodeMirror结合remark实现更定制化方案，适用于需要自定义行为或避免引入完整富文本编辑器的场景；3. 注意样式兼容问题，建议使用CSS Modules隔离样式影响，并统一主题风格与响应式适配；此外，数据保存时应保留原始Markdown内容，渲染时避免直接使用不可信来源的HTML，确保数据安全。

在 Ant Design Pro 项目中嵌入 Markdown 编辑器，其实是一个比较常见的需求，比如用于内容发布、文档编辑等场景。关键在于选择合适的 Markdown 编辑器组件，并将其适配到 Ant Design Pro 的页面结构和样式体系中。

下面介绍几种常用方法和注意事项，帮助你顺利集成 Markdown 编辑器。

1. 使用 react-markdown-editor-lite 快速接入

这是一个轻量且功能齐全的 React Markdown 编辑器组件，支持实时预览、语法高亮等功能，适合大多数项目使用。

步骤如下：

• 安装依赖：

npm install react-markdown-editor-lite markdown-it

• 在页面中引入并使用：

import React, { useState } from 'react';
import MdEditor from 'react-markdown-editor-lite';
import MarkdownIt from 'markdown-it';

const mdParser = new MarkdownIt();

const MarkdownEditor = () => {
  const [content, setContent] = useState('');

  const handleEditorChange = ({ html, text }) => {
    setContent(text);
  };

  return (
    
  );
};

export default MarkdownEditor;

优点：

• 上手简单，开箱即用。
• 支持代码块高亮、表格、表情等常见功能。
• 和 Ant Design Pro 兼容性较好。

2. 使用 CodeMirror + remark 实现更定制化方案

如果你需要一个更轻量或高度定制的编辑器（例如仅支持纯文本输入），可以结合 CodeMirror 和 remark 来实现。

步骤如下：

• 安装依赖：

npm install codemirror @codemirror/lang-markdown @codemirror/lang-html remark remark-html

• 基本使用示例：

import React, { useEffect, useRef } from 'react';
import { EditorView } from 'codemirror';
import { markdown } from '@codemirror/lang-markdown';
import remark from 'remark';
import html from 'remark-html';

const MarkdownCodeMirror = () => {
  const editorRef = useRef(null);

  useEffect(() => {
    if (editorRef.current) {
      const view = new EditorView({
        extensions: [markdown()],
        parent: editorRef.current,
      });
    }
  }, []);

  return 
;
};

你可以将用户输入的内容通过 remark 转换为 HTML 进行展示。

适用场景：

• 需要自定义编辑器行为（如快捷键、语法检查）。
• 不希望引入完整富文本编辑器。

3. 注意事项与样式兼容问题

Ant Design Pro 默认使用了 antd 的样式系统，而一些 Markdown 编辑器可能会自带样式，容易出现样式冲突或显示异常。

建议处理方式：

• 隔离样式影响：

  • 使用 CSS Modules 或 scoped 样式（如果是 CSS-in-JS 方案）。
  • 将编辑器包裹在一个独立容器，并限制其样式作用域。

• 统一主题风格：

  • 修改编辑器的默认样式文件，使其颜色、字体与 Ant Design 主题一致。
  • 可以参考 antd 的变量来调整编辑器的主题色。

• 移动端适配：

  • 检查编辑器在小屏幕下的布局表现，必要时添加响应式样式。

4. 数据保存与渲染安全

当你在 Ant Design Pro 中使用 Markdown 编辑器时，最终往往需要将内容保存并渲染成 HTML 页面。

需要注意以下几点：

• 存储时应保留原始 Markdown 内容，而不是直接存储 HTML。
• 渲染时避免使用 dangerouslySetInnerHTML，除非你信任内容来源。
• 如果是用户提交内容，建议使用白名单机制过滤 HTML 标签。

基本上就这些。
Markdown 编辑器的嵌入虽然不复杂，但要注意组件选型、样式兼容和数据安全这几个关键点。只要按需选择合适组件并做好细节处理，就能很好地集成到 Ant Design Pro 项目中。