导语

作为一种轻量便捷的文本标记语言，Markdown已在互联网等行业得到广泛的应用。Markdown语法没有强制统一的标准，不同平台使用的Markdown编辑器在语法和功能特性上都各有差异，使用者和开发者都面临不小的对齐、适配成本。

CherryMarkdown是一款使用者和开发者友好的Markdown编辑器前端组件，具有开箱即用、易于扩展、语法和功能丰富等特点，致力于帮助使用者和开发者降低编辑、开发成本，快速聚焦到编辑和创作中。

现将CherryMarkdown对外开源，为开源社区贡献力量。

主要设计目标

1. 开箱即用

接入成本低，开发者能便捷地调用并实例化编辑器；适配成本低，支持全屏、嵌入、移动端等多形态引入。

2. 易于扩展

由原生ES6实现，开发者可以快速进行二次开发和功能扩展；可以方便地使用vue/react等主流框架进行二次封装。

3. 语法和功能丰富

支持主流Markdown语法，支持实用的扩展语法和便捷的功能特性。

4. 性能优秀

通过局部渲染和局部更新机制，达到业界领先的渲染性能，让编辑体验更加流畅。

（CherryMarkdown组件架构图）

 亮点特性简介

1. 图片语法&所见即所得编辑

CherryMarkdown支持通过语法指定图片的大小和位置等属性，且允许在预览区进行所见即所得的编辑交互。

2. 图表绘制

在传统Markdown表格的基础上，CherryMarkdown支持绘制相应的统计图。

3. 粘贴HTML自动转Markdown

从其他页面复制HTML并粘贴到CherryMarkdown，能自动转成相应的Markdown源码。

4. 多光标编辑

CherryMarkdown支持和主流代码编辑器体验类似的多光标批量编辑功能。

5. 变更检测与局部更新

内容变更时，CherryMarkdown能精准检测和定位，做最小的页面元素改动，实现优秀渲染性能。

CherryMarkdown项目规划

1. 持续建设跨平台能力（导出功能、服务端渲染）、主题能力、系统功能&插件功能；

2. 持续优化所见即所得编辑模式，增加插入思维导图能力，优化移动端适配；

3. 增加快捷键等快捷操作指令，增加第三方插件包（如插入vscode），增加本地应用安装包。

CherryMarkdown开源地址

https://github.com/Tencent/cherry-markdown