Tencent /cherry-markdown

✨ A Markdown Editor

★ 4,931⑂ 583👁 47⑃ 1,071● 838▤ 127
TypeScriptNOASSERTIONCreated 2021-10-15github.com/Tencent/cherry-markdown/wiki
+0
Daily
4,931
stars
583
forks
47
watchers
1,071
prs
838
issues
127
releases

README

Cherry Markdown Writer

 

English | 简体中文

 Introduction

Cherry Markdown Writer is a JavaScript Markdown editor. It has the advantages such as out-of-the-box, lightweight and easy to extend. It can run in browser or server(with Node.js).

 Document

- Getting Started with Cherry Markdown Editor
- hello world
- Configuring Image & File Upload Interfaces
- Adjusting the Toolbar
- Comprehensive Configuration Options
- Custom Syntax
- Configuring Themes
- Extending Code Block Syntax
- Events & Callbacks
- Build Artifacts (Full / Core / Stream / Engine)
- API

 Demos

- Full Mode
- Basic
- Mobile
- Multiple Instances
- Editor Without Toolbar
- Pure Preview
- XSS (Disabled by default; requires configuration to enable XSS)
- IMG WYSIWYG
- Table WYSIWYG
- Headers with Auto Num
- Streaming rendering Mode (AI chat scenario)
- Streaming Mode - Lazy Loading Plugins
- VIM Editing Mode
- Utilize Your Own Mermaid.js
- Custom Code Block Wrapper

 Features

- Out-of-the-box — Instantiate with a single call; most common Markdown syntax (headings, TOC, flowcharts, formulas, etc.) works by default.
- Easy to extend — Pure JavaScript implementation, no framework dependency (Angular/Vue/React only serve as container environments). Custom syntax, toolbar buttons and themes are all supported.
- Streaming rendering — Purpose-built for AI Chat scenarios. Auto-completes unfinished Markdown fragments during token streaming to prevent raw source flashing.
- Rich editing experience — Multi-cursor editing, floating & bubble toolbars, floating TOC, input autocomplete, VIM mode, shortcut key customization, and theme switching.
- Powerful diagrams & media — Mermaid diagrams (with drag-to-resize and alignment), math formulas, table-to-chart, image resize & alignment, audio/video embedding.
- Export & interoperability — Paste from rich text as Markdown, export to Image / PDF, WYSIWYG editing for images and tables.
- High performance & secure — Partial rendering & partial update; built-in whitelist filtering and DomPurify to prevent XSS.

For a visual walkthrough, see the demo.

 Downloads

 Desktop Client

Cherry Markdown ships a cross-platform desktop client (built with Tauri) for Windows, macOS and Linux. It supports opening / editing local .md / .markdown / .txt files with the same editing experience as the web version.

👉 Download the latest release

 VSCode Extension

Prefer editing Markdown right inside VSCode? Cherry Markdown also provides an official VSCode extension with the same rich editing & preview experience.

👉 Install from VSCode Marketplace

 Install as a package

Via yarn

bash
yarn add cherry-markdown


Via npm

bash
npm install cherry-markdown --save


 CDN usage

Use the UMD artifact for a regular  tag, and pin the package version:

html




The UMD artifact exposes the global Cherry variable. For native ESM:

html

  import Cherry from 'https://cdn.jsdelivr.net/npm/[email protected]/dist/cherry-markdown.esm.js';

  const cherry = new Cherry({ id: 'markdo

Top issues

Discussions

Latest release

[email protected] [email protected] 2026-11-10
Minor Changes

- feat(vscodePlugin): 统一上传配置、支持 PicGo multipart,并为重要行为变化提供一次性更新说明

  - 上传配置按当前文档所属文件夹、工作区、用户、默认值的顺序读取。上传器地址和认证头整体取自同一层,避免项目地址混入全局认证信息。
  - 配置无效时阻止上传并提示修正,不静默切换上传目标。
  - 重要行为变化会显示一次性更新说明通知,可查看随插件打包的本地说明或打开上传设置,也可从命令面板重新查看。通知按重要变更标识记录,普通 patch、关闭通知和重载窗口不会重复提示;首次上线无法可靠区分新装和升级,因此首次启用都会提示一次。
  - 仅记录扩展内部通知状态,不迁移用户设置,上传时的配置错误提醒继续保留。
  - CustomUploader.format 支持 binary 和 multipart,省略时仍使用原有的 binary 行为。
  - PicGo 2.4.0+ 用户可设置 ImageUploadMode=remote、format=multipart、fieldName=files 继续上传;插件直接发送文件内容,自动生成表单边界和长度,不根据地址猜测协议,也不在失败后切换路线。
  - 停止使用旧 UploadType、PicGoServer 选择上传方式和地址,不提供旧路径列表或剪贴板协议适配

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON