Sym - 一个用 Java 实现的现代化社区平台 • 源码 • 注册

Pipe - 小而美的开源博客平台 • 体验 • 皮肤
Solo - 一个用 Java 实现的博客系统,为你或你的团队创建个博客吧! • 源码下载 
Wide - 一个基于 Web 的 Go 语言 IDE • 教程试用

Vditor - 浏览器端的 Markdown 编辑器

Vditor
下一代的 Markdown 编辑器,为未来而构建

npm bundle size


💡 简介

Vditor 是一款浏览器端的 Markdown 编辑器,使用 TypeScript 实现。支持原生 JavaScript、Vue、React、Angular。

📽️ 背景

我们在开发 Sym 的初期是直接使用 WYSIWYG 富文本编辑器的。那时候基于 HTML 的编辑器非常流行,项目中引用起来也很方便,也符合用户当时的使用习惯。

后来,Markdown 的崛起逐步改变了大家的排版方式。再加上我们其他几个项目都是面向程序员用户的,所以迁移到 md 上也是大势所趋。我们选择了 CodeMirror,这是一款优秀的编辑器,它对开发者提供了丰富的编程接口,对各种浏览器的兼容性也比较好。

再后来,随着我们项目业务需求方面的沉淀,使用 CodeMirror 有时候会感到比较“笨重”。比如要实现 @自动完成用户名列表、插入 Emoji、上传文件等就需要比较深入的二次开发,而这些业务需求恰恰是很多项目场景共有且必备的。

终于,我们决定开始在 Sym 中自己实现编辑器。随着几个版本的迭代,Sym 的编辑器也日趋成熟。在我们运营的社区黑客派上陆续有人问我们是否能将编辑器单独抽离出来提供给大家使用。与此同时,我们的前端主程 V 同学对于维护分散在各个项目中的编辑器也感到有点力不从心,外加对 TypeScript 的好感,所以就决定使用 ts 来实现一个全新的浏览器端 md 编辑器。

于是,Vditor 就这样诞生了。

✨ 特性

  • 所见即所得编辑模式(正在实现中)
  • 支持任务列表、at、图表、流程图、甘特图、时序图、五线谱、多媒体、语音阅读、标题锚点渲染
  • 支持自定义 duplicate、delete 快捷键操作
  • 支持 Markdown 格式化, Markdown 语法树实时渲染
  • 表情自动补全,设置常用表情,支持表情自定义
  • 自定义工具栏按钮、提示、插入字符、快捷键,支持工具栏添加按钮
  • 可使用拖拽、剪切板粘贴上传,显示实时上传进度,支持 CORS 跨域上传
  • 实时保存内容,防止意外丢失
  • 录音支持,用户可直接发布语音
  • 粘贴 HTML 自动转换为 Markdown,如粘贴中包含外链图片可通过指定接口上传到服务器
  • 提供实时预览、滚动同步定位
  • 支持主窗口大小拖拽、字符计数
  • 多主题支持、内置黑白两套
  • 多语言支持、内置中英文
  • 支持主流浏览器和移动端

demo
render

🗃 案例

  • Sym:一款用 Java 实现的现代化社区(论坛/BBS/社交网络/博客)平台
  • Starfire:一个分布式的内容分享讨论社区,通过点对点超媒体协议让社区更快、更安全也更开放
  • Solo:一款小而美的博客系统,使用 Java 实现
  • Pipe:一款小而美的博客平台,使用 Go 实现

🛠️ 使用文档

CommonJS

  • 安装依赖
npm install vditor --save
  • 在代码中引入并初始化对象,可参考 index.js
import Vditor from 'vditor'
import "~vditor/src/assets/scss/classic" // 或者使用 dark

const vditor = new Vditor(id, {options...})
vditor.focus()

HTML script

  • 在 HTML 中插入 CSS 和 js,可参考 static.html
<!-- ⚠️生产环境请指定版本号,如 https://cdn.jsdelivr.net/npm/vditor@x.x.x/dist... -->
<!-- 可使用 index.dark.css 或 index.classic.css -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/vditor/dist/index.classic.css" />
<script src="https://cdn.jsdelivr.net/npm/vditor/dist/index.min.js" defer></script>
const vditor = new Vditor(id, {options...})
vditor.focus()

示例代码

CSS

在 DOM 元素上添加 class="vditor-reset" 属性可对内容进行更为友好的展示。

API

options

说明 默认值
after 编辑器异步渲染完成后的回调方法 undefined
cache 是否使用 localStorage 进行缓存 true
height 编辑器总高度 'auto'
width 编辑器总宽度,支持 % 'auto'
placeholder 输入区域为空时的提示 ''
lang 多语言:en_US, zh_CN 'zh_CN'
counter 计数器 0
input 输入后触发 (value: string, previewElement?: HTMLElement): void -
focus 聚焦后触发 (value: string): void -
blur 失焦后触发 (value: string): void -
esc esc 按下后触发 (value: string): void -
ctrlEnter ⌘/ctrl+enter 按下后触发 (value: string): void -
select 编辑器中选中文字后触发 (value: string): void -
tab tab 键操作字符串,支持 \t 及任意字符串 -
typewriterMode 是否启用打字机模式 false

options.toolbar

  • 工具栏,可使用 name 进行简写:toolbar: ['emoji', 'br', 'bold', '|', 'line']。默认值参见 src/ts/util/Options.ts
  • name 可枚举为:emoji, headings, bold, italic, strike, |, line, quote, list, ordered-list, check, code, inline-code, undo, redo, upload, link, table, record, both, preview, format, fullscreen, devtools, info, help, br
  • name 不在枚举中时,可以添加自定义按钮,格式如下:
{  
 hotkey: '⌘-⇧-f',  
 name: 'format',  
 tipPosition: 'ne',  
 tip: 'format',  
 icon: '<svg version="1.1" xmlns="http://www.w3.org/2000/svg" width="768" height="768" viewBox="0 0 768 768"><path d="M342 426v-84h426v84h-426zM342 256v-86h426v86h-426zM0 0h768v86h-768v-86zM342 598v-86h426v86h-426zM0 214l170 170-170 170v-340zM0 768v-86h768v86h-768z"></path></svg>',  
 click: () => {  
   alert('custom toolbar')  
 },  
}  
说明 默认值
name 唯一标示 -
icon svg 图标 -
tip 提示 -
tipPosition 提示位置:ne, nw -
hotkey 快捷键,支持 ⌘/ctrl-key 或 ⌘/ctrl-⇧/shif-key 格式的配置 -
suffix 插入编辑器中的后缀 -
prefix 插入编辑器中的前缀 -
click 自定义按钮点击时触发的事件 ():viod -

options.preview

说明 默认值
delay 预览 debounce 毫秒间隔 1000
mode 显示模式:'both', 'editor', 'preview' 'both'
parse 预览回调 (element: HTMLElement): void -
url md 解析请求 -

options.preview.hljs

说明 默认值
enable 是否启用代码高亮 true
style 可选值参见 Chroma 'github'
lineNumber 是否启用行号 false

options.hint

说明 默认值
delay 提示 debounce 毫秒间隔 200
emoji 默认表情,可从 lute/emoji_map 中选取,也可自定义 { '+1': '👍', '-1': '👎', 'heart': '❤️', 'cold_sweat': '😰' }
emojiTail 常用表情提示 -
emojiPath 表情图片地址 https://cdn.jsdelivr.net/npm/vditor/src/assets/emoji
at @用户回调,(value: string): Array,需同步返回数组[{value: '', html: ''}] -

options.upload

  • ⚠️ filename 需和 options.uploads.filename 保持一致,否则将导致编辑器中出现多个链接
  • 后端返回的数据结构不一致时,可使用 format 进行转换。文件上传的数据结构如下:
// POST data  
xhr.send(formData);  // formData = FormData.append("file[]", File)  
// return data  
{  
 "msg": "",  
 "code": 0,  
 "data": {  
 "errFiles": ['filename', 'filename2'],  
 "succMap": {  
   "filename3": "filepath3",  
   "filename3": "filepath3"  
   }  
 }  
}  
  • 为了防止站外图片失效,linkToImgUrl 可将剪贴板中的站外图片地址传到服务器端进行保存处理,其数据结构如下:
// POST data  
xhr.send(JSON.stringify({url: src})); // src 为站外图片地址  
// return data  
{  
 msg: '',  
 code: 0,  
 data : {  
   originalURL: '',  
   url: ''  
 }  
}  
说明 默认值
url 上传 url,查看规范 ''
max 上传文件最大 Byte 10 * 1024 * 1024
linkToImgUrl 剪切板中包含图片地址时,使用此 url 重新上传 ''
success 上传成功回调 (editor: HTMLPreElement, msg: string): void -
error 上传失败回调 (msg: string): void -
token CORS 上传验证,头为 X-Upload-Token -
withCredentials 跨站点访问控制 false
filename 文件名安全处理 (name: string): string name => name.replace(/\W/g, '')
accept 文件上传类型,同 input accept -
validate 校验,成功时返回 true 否则返回错误信息 (files: File[]) => string | boolean -
handler 自定义上传,当发生错误时返回错误信息 (files: File[]) => string | null -
format 对服务端返回的数据进行转换,以满足内置的数据结构 (files: File[], responseText: string): string -

options.resize

说明 默认值
enable 是否支持大小拖拽 false
position 拖拽栏位置:top, bottom 'bottom'
after 拖拽结束的回调 (height: number): void -

options.classes

说明 默认值
preview 预览元素上的 className ''

options.keymap

说明 默认值
deleteLine 删除光标所在行或选中的行 ⌘-Backspace
duplicate 复制当前行或选中的内容 ⌘-d

methods

说明
getValue() 获取编辑器内容
getHTML() 获取预览区内容。该方法需使用异步编程
insertValue(value: string) 在焦点处插入内容
focus() 聚焦到编辑器
blur() 让编辑器失焦
disabled() 禁用编辑器
enable() 解除编辑器禁用
setSelection(start: number, end: number) 选中从 start 开始到 end 结束的字符串
getSelection():string 返回选中的字符串
setValue(value: string) 设置编辑器内容
renderPreview(value?: string) 设置预览区域内容
getCursorPosition():{top: number, left: number} 获取焦点位置
deleteValue() 删除选中内容
updateValue(value: string) 更新选中内容
isUploading() 上传是否还在进行中
clearCache() 清除缓存
disabledCache() 禁用缓存
enableCache() 启用缓存
html2md(value: string) HTML 转 md。该方法需使用异步编程
tip(text:string, time:number) 消息提示。time 为 0 将一直显示
setPreviewMode(mode: string) 设置预览模式。mode: 'both', 'editor', 'preview'

static methods

  • 不需要进行编辑操作时,仅需引入 method.min.js 后如下直接调用
Vditor.mermaidRender(document)  
import VditorPreview from 'vditor/dist/method.min'  
VditorPreview.mermaidRender(document)  
  • 需要对页面中的 Markdown 进行渲染时可直接调用 preview 方法,参数如下:
previewElement: HTMLDivElement,   // 使用该元素进行渲染
markdown: string,  // 需要渲染的 markdown 原文
options?: IPreviewOptions {  
 anchor?: boolean;  // 为标题添加锚点
 className?: string;  // 渲染元素的 class,默认为 'vditor-reset'
 customEmoji?: { [key: string]: string };    // 自定义 emoji,默认为 {}  
 lang?: (keyof II18nLang);    // 语言,默认为 'zh_CN'  
 emojiPath?: string;    // 表情图片路径 
 hljs?: IHljs // 参见 options.preview.hljs 
 speech?: {  // 对选中后的内容进行阅读
  enable?: boolean
 }
}  
  • ⚠️method.min.jsindex.min.js 不可同时引入
说明
mathRender(element: HTMLElement) 转换 element 中的文本为数学公式
mermaidRender(element: HTMLElement) 转换 element 中的文本为流程图/时序图/甘特图
codeRender(element: HTMLElement, lang: (keyof II18nLang) = "zh_CN") 为 element 中的代码块添加复制按钮
chartRender(element: (HTMLElement | Document) = document) 图表渲染
abcRender(element: (HTMLElement | Document) = document) 五线谱渲染
md2html(mdText: string, options?: IPreviewOptions): string Markdown 文本转换为 HTML,该方法需使用异步编程
preview(previewElement: HTMLDivElement, markdown: string, options?: IPreviewOptions) 页面 Markdown 文章渲染
highlightRender(hljsOption?:IHljs, element?: HTMLElement | Document) 为 element 中的代码块进行高亮渲染
mediaRender(element: HTMLElement) 特定链接分别渲染为视频、音频、嵌入的 iframe
mathRenderByLute(element: HTMLElement) 对使用 Lute 渲染的数学公式进行渲染
speechRender(element: HTMLElement, lang?: (keyof II18nLang)) 对选中的文字进行阅读

升级

版本升级时请仔细阅读 CHANGELOG升级部分

🏗 开发文档

  1. 安装 node LTS 版本
  2. 下载 最新代码并解压
  3. 根目录运行 npm install
  4. npm run start 启动本地服务器,打开 http://localhost:9000
  5. 修改代码
  6. npm run build 打包代码到 dist 目录

⚠️ 注意事项

🏘️ 社区

📄 授权

Vditor 使用 MIT 开源协议。

🙏 鸣谢

  • Lute:🎼 一款结构化的 Markdown 引擎,支持 Go 和 JavaScript
  • highlight.js:JavaScript syntax highlighter
  • Turndown:🛏 An HTML to Markdown converter written in JavaScript
  • mermaid:Generation of diagram and flowchart from text in a similar manner as Markdown
  • incubator-echarts:A powerful, interactive charting and visualization library for browser
  • abcjs:JavaScript library for rendering standard music notation in a browser

欢迎注册黑客派社区,开启你的博客之旅。让学习和分享成为一种习惯!

142 评论
Vanessa • 2019-11-08
回复 删除
  1. 稍后更新到 1.9.4,IPreviewOptions 增加配置按钮,默认关闭
       className?: string;
       customEmoji?: { [key: string]: string };
       lang?: (keyof II18nLang);
       emojiPath?: string;
       hljs?: {
          lineNumber?: boolean;
          style?: string;
          enable?: boolean;
       };
       speech?: {
           enable?: boolean
       }
  1. 我只有 Mac,你可以先看一下官方示例在微软浏览器中是否会出现滚动条

  2. 目前还没有遇到非常卡的问题,希望能提供一下以下数据:

    • 字符达到多少时会出现非常卡的现象
    • 你站点的用户一般输入字符为多少
    • 预览关了还卡么
    • 出现非常卡的原文
547176052 • 2019-11-08
回复 删除

预览关了不卡

547176052 • 2019-11-08
回复 删除
  • 字符达到多少时会出现非常卡的现象 5000 左右
  • 你站点的用户一般输入字符为多少 还没布置站点需要的话可以弄一个
  • 预览关了还卡么 关了不卡
  • 出现非常卡的原文 官方例子
Vanessa • 2019-11-08
回复 删除

非常感谢,请升级到 1.9.5 后进再看一下。如果卡的话可以修改 options.preview.delay 参数

547176052 • 2019-11-08
回复 删除

还有一个问题,能不能设置为每个 h 元素加个 id,我想弄个目录跳转到指定 h 元素

547176052 • 2019-11-08
回复 删除
  const vditor = new Vditor('vditor', {
	//hljsStyle:'dracula',//设置代码高亮颜色
	preview:{
		delay:30000,
		mode:'both',//模式
		hljs:{
			style:'native',//设置代码高亮颜色
		}
	},
	
	
    typewriterMode: false,//打印机模式
	placeholder:'请使用Markdown语法编写',

    counter: 100,
    height: 462,


	
	resize:{
		enable:true,//是否支持大小拖拽
	},






  });

这样设置延迟好像不生效

Vanessa • 2019-11-08
回复 删除

你看一下这个 https://github.com/b3log/lute/issues/21 能满足么?如果可以的话请关注这个 issue 即可。

Vanessa • 2019-11-08
回复 删除

请检查一下引入的版本号是否为 1.9.5

547176052 • 2019-11-08
回复 删除

更新 1.9.5 然后清除缓存,果然不卡了

547176052 • 2019-11-08
回复 删除

这个是扩展 md 语法,我的意思是指要把 md 语言渲染后的 h 元素加个 id 就好,渲染完成后我直接遍历所有 h 元素然后加目录

Vanessa • 2019-11-08
回复 删除
547176052 • 2019-11-09
回复 删除

渲染有点卡

https://142536.vip/dz/forum.php?mod=viewthread&tid=31&extra=page%3D1

页面加载完成后你滚动条 滚一下试试看

547176052 • 2019-11-09
回复 删除

image.png

547176052 • 2019-11-09
回复 删除
Vditor.preview()

页面中的 Markdown 进行渲染 完成后有没有回调

547176052 • 2019-11-09
回复 删除
<?php
//http://localhost/dz/plugin.php?id=qq547176052:1
//plugin.php?id=qq547176052:1
header('Content-Type:application/json; charset=utf-8');
$ml = "source/plugin/qq547176052/photo/";
	$picData = $_FILES['Filedata'];
    $imgname = "666";//$_FILES['myfile']['name'];
    $tmp = $_FILES['myfile']['tmp_name'];
    $filepath = $ml;
    if(move_uploaded_file($tmp,$filepath.$imgname.".png")){
        $n = "成功";
    }else{
        $n = "失败";
    }

$arr = array(
	'code'=>1,
	'msg'=>$n,
	'data'=>"json type"
	
);
exit(json_encode($arr));
?>

PHP 端怎么接收图片保存