Skip to content

Home

Jump to bottom
yi-ge edited this page Mar 23, 2026 · 16 revisions

SuperDoc (@desirecore/super-doc)

SuperDoc 是基于 Tencent/cherry-markdown 的独立维护分支，新增了完整的 WYSIWYG 编辑模式、流式渲染等重大特性，并修复了大量 bug。由于改动与上游差异过大，为避免对上游造成负担和对使用者引入兼容性问题，因此独立维护并重新发布为 @desirecore/super-doc。

本项目遵循 Apache License 2.0，完整保留上游许可证和第三方组件声明。

与上游的主要差异

详见 SuperDoc 新增特性与修改说明

核心新增

  • WYSIWYG 所见即所得编辑模式 — 基于 Milkdown/ProseMirror，支持一键切换
  • Stream 流式渲染模式 — 面向 AI 聊天场景的轻量级渲染
  • 自定义 ProseMirror 节点 — 图片拖拽缩放/对齐、TOC 可编辑目录、脚注、draw.io、音视频、Panel、Ruby 注音、Detail 折叠等
  • 丰富的文字样式 — 字体颜色、背景色、字号、高亮、下划线、上下标
  • 大量 Bug 修复 — 包括 KaTeX 渲染、表格编辑、超链接、粘贴、公式等 30+ 项修复

安装

# npm
npm install @desirecore/super-doc

# yarn
yarn add @desirecore/super-doc

快速开始

import SuperDoc from '@desirecore/super-doc';
import '@desirecore/super-doc/dist/super-doc.min.css';

const editor = new SuperDoc({
  id: 'markdown-container',
  value: '# Hello SuperDoc',
});

构建产物

文件 说明
super-doc.js 完整 UMD 包（含 mermaid + plantuml + echarts）
super-doc.esm.js ESM 格式
super-doc.core.js 核心包（不含 mermaid 等重型插件）
super-doc.engine.js 仅引擎（无编辑器 UI，适用于服务端渲染）
super-doc.stream.js 流式渲染包（AI 聊天场景）
super-doc.min.css 样式文件

详见 构建产物介绍

本地开发

cd super-doc
yarn install
yarn dev

文档目录

入门

配置

扩展

SuperDoc 新增

其他

特别注意

Vue 3 用户需避免使用代理 SuperDoc 实例的方式，否则会引入各种 bug。详见 相关 issue。

致谢

本项目基于 Tencent/cherry-markdown，感谢 Cherry Oteam 和所有贡献者的出色工作。

SuperDoc

入门

配置

扩展

其他

Clone this wiki locally