Home

在线体验地址

• 全部功能
  • 双栏编辑模式（顶部工具栏、左侧编辑器、右侧预览器）
  • 自定义工具栏（三种实现方案）
  • 自定义语法
  • 右侧预览器表格、图片尺寸支持编辑
  • 左右滚动支持联动
  • 切换主题等
• 最简实现
  • 几乎完全使用默认配置
  • 基本上就是引入css、引入js、定义一个div、三行代码实现
• H5
  • 纯编辑模式和纯预览模式
• 多实例
• 无 toolbar
• 纯预览模式
• 注入
  • 演示如何通过配置实现支持注入
  • 使用场景：在查看页需要运行js、渲染iframe等
• 图片所见即所得编辑尺寸
• 表格所见即所得编辑尺寸
• 标题自动序号
• 流式输入模式（AI chart场景）
  • 打开流式输入模式后，加粗斜体、代码块、无序列表、表格等内容的输入更加稳定（样式不会突然跳变或反复横跳）

从入门到下班

简介

cherry markdown是一款前端-markdown-编辑器-组件：

• 前端：本项目只有前端工程，没有提供后台服务代码
• markdown：写markdown的
• 编辑器：由工具栏、编辑区、预览区、解析引擎四部分组成
• 组件：提供自定义工具栏、自定义语法以及各种api

构建产物

也可以直接引用/dist/目录下的js和css文件，各文件解释请参考构建产物介绍

本地开发

cd cherry-markdown
yarn
yarn dev

贡献指南

贡献指南

特性展示

特性展示 features

特别注意

vue3选手需要避免使用代理cherry实例的方式，否则会引入各种蜜汁bug

目录

• 特性展示
• 初识cherry markdown 编辑器
• 构建产物介绍&引入mermaid和echarts
• hello world
• 配置图片&文件上传接口
• 调整工具栏
• 自定义语法
• 处理URL
• 图片懒加载
• 配置项全解
• 配置主题
• 配置快捷键
• 扩展代码块语法
• 多语言
• 事件&回调
• API
• 竞品分析