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...})

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>

示例代码

主题

  • 支持黑白两套主题:classic/dark
  • 参考现有样式后使用自己开发的 scss/css 进行样式的完全自定制
  • 可通过修改 classic.scss/dark.scss 中的变量对主题颜色进行定制
  • 在内容显示元素上添加 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
cdn 配置自建 CDN 地址 https://cdn.jsdelivr.net/npm/vditor@${VDITOR_VERSION}

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 格式的配置,不支持 wysiwyg 模式 -
suffix 插入编辑器中的后缀 -
prefix 插入编辑器中的前缀 -
click 自定义按钮点击时触发的事件 ():viod -

options.preview

说明 默认值
delay 预览 debounce 毫秒间隔 1000
mode 显示模式:'both', 'editor', 'preview' 'both'
url md 解析请求 -
inlineMathDigit 内联数学公式起始 $ 后是否允许数字 false
parse 预览回调 (element: HTMLElement): void -
transform 渲染之前回调(html: string): string -

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 表情图片地址 ../dist/images/emoji
at @用户回调,(value: string): Array,需同步返回数组[{value: '', html: ''}] -

options.upload

  • 后端返回的数据结构不一致时,可使用 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
headers 请求头设置 -
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 结束的字符串,不支持 wysiwyg 模式
getSelection():string 返回选中的字符串
setValue(markdown: 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
 }
 inlineMathDigit?: boolean // 内联数学公式起始 $ 后是否允许数字
 transform?(html: string): string // 在渲染前进行的回调方法
 cdn?: string // 自建 CDN 地址
}  
  • ⚠️method.min.jsindex.min.js 不可同时引入
说明
mathRender(element: HTMLElement, cdn = options.cdn) 转换 element 中的文本为数学公式
mermaidRender(element: HTMLElement, className = ".language-mermaid", cdn = options.cdn) 转换 element 中 class 为 className 的元素为流程图/时序图/甘特图
codeRender(element: HTMLElement, lang: (keyof II18nLang) = "zh_CN") 为 element 中的代码块添加复制按钮
chartRender(element: (HTMLElement | Document) = document, cdn = options.cdn) 图表渲染
abcRender(element: (HTMLElement | Document) = document, cdn = options.cdn) 五线谱渲染
md2html(mdText: string, options?: IPreviewOptions): string markdown 文本转换为 HTML,该方法需使用异步编程
preview(previewElement: HTMLDivElement, markdown: string, options?: IPreviewOptions) 页面 Markdown 文章渲染
highlightRender(hljsOption?:IHljs, element?: HTMLElement | Document, cdn = options.cdn) 为 element 中的代码块进行高亮渲染
mediaRender(element: HTMLElement) 特定链接分别渲染为视频、音频、嵌入的 iframe
mathRenderByLute(element: HTMLElement, cdn = options.cdn) 对使用 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 目录

CDN 切换

由于使用了按需加载的机制,默认 CDN 为 https://cdn.jsdelivr.net/npm/vditor@版本号

如果代码有修改或需要使用自建 CDN 的话,可按以下步骤进行操作:

  • 初始化的 optionsIPreviewOptions 中需添加 cdn 配置
  • highlightRender, mathRenderByLute, mathRender, abcRender, chartRender, mermaidRender 方法中需添加 cdn 参数
  • 将 build 成功的 dist 目录或 jsDelivr 中的 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

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

推荐阅读
155 评论
Vanessa • 2019-09-17
回复 删除
onclick="vditor.insertValue('1')"

我在代码 https://github.com/b3log/vditor/blob/master/demo/index.html 中加如以上代码测试是可以的。麻烦更新到最新版本,或给出相关代码。

haaid • 2019-09-17
回复 删除

我是写到了 Vue 的 mounted 方法中,这个代码在例子中(GitHub 的 demo/index.js)可以,Vue 中就不行,我断点看到有值的。

01.png

02.png

buexplain • 2019-10-13
回复 删除

image.png
自定义上传返回的数据结构对不?有没有更详细的示例。

Vanessa • 2019-10-16
回复 删除

可能还是有点问题的,这几天度假中,过两天回去看。谢谢

gitors • 2019-10-17
回复 删除

此链接 404

xiluotop • 2019-10-18
回复 删除

我可以分享到我的博客嘛,我会标明来源的 😋

Vanessa • 2019-10-20
回复 删除

只对数据结构进行转换的话可以使用 options.upload.format

qkzzxb • 2019-10-22
回复 删除

vditor 如何生成 toc 目录,看配置文件没有提到这个,要自己魔改吗huaji

Vanessa • 2019-10-22
回复 删除

目前还没有该功能

qkzzxb • 2019-10-22
回复 删除

比如说这个帖子右侧的目录是通过别的方法生成的吗?

Vanessa • 2019-10-22
回复 删除

是的,这个和 vditor 没有关系

qkzzxb • 2019-10-22
回复 删除

谢谢大佬,我在 symphony 的项目里找到了相关源码

547176052 • 2019-10-24
回复 删除

image.png
溢出是啥错误

547176052 • 2019-10-24
回复 删除

image.png

Vanessa • 2019-10-24
回复 删除

升级 node 版本再试一下