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

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

Vditor 使用指南

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

npm bundle size




Start

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()

Example Code

Screenshot

classic

black

API

options

说明 默认值
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 及任意字符串 -

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, fullscreen, 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 highlight.js 样式文件名 'atom-one-light'

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 将其转换为如下内置的数据结构:

{
    "msg": "",
    "code": 0,
    "data": {
        "errFiles": ['filename', 'filename2'],
        "succMap": {
            "filename3": "filepath3",
            "filename3": "filepath3"
        }
    }
}
说明 默认值
url 上传 url,查看规范 ''
max 上传文件最大 Byte 10 * 1024 * 1024
linkToImgUrl 剪切板中包含图片地址时,使用此 url 重新上传 ''
success 上传成功回调 (editor: HTMLPreElement, msg: string): void -
error 上传失败回调 (msg: string): void -
token CORS 上传验证,头为 X-Upload-Token -
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.hotkey

说明 默认值
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 方法,参数如下:
element: HTMLTextAreaElement    // 为保证 Markdown 的完整性,请将其包裹在 textarea 中
options?: IPreviewOptions {
    hljsStyle?: string;    // 高亮样式,默认为 'atom-one-light'
    enableHighlight?: boolean;    // 是否需要代码高亮,默认为 true
    customEmoji?: { [key: string]: string };    // 自定义 emoji,默认为 {}
    lang?: (keyof II18nLang);    // 语言,默认为 'zh_CN'
}
  • ⚠️method.min.jsindex.min.js 不可同时引入
说明
mathRender(element: HTMLElement, lang: (keyof II18nLang) = "zh_CN") 转换 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): string Markdown 文本转换为 HTML,该方法需使用异步编程
preview(element: HTMLTextAreaElement, options?: IPreviewOptions) 页面 Markdown 文章渲染
emojiRender(text: string, customEmoji?: { [key: string]: string }): string 替换文本中的 :emoji: 为 emoji
highlightRender(hljsStyle: string, enableHighlight: boolean, element?: HTMLElement | Document) 为 element 中的代码块进行高亮渲染
mediaRender(element: HTMLElement) 特定链接分别渲染为视频、音频、嵌入的 iframe

CSS

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

Dev

升级

CHANGELOG

开发步骤

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

注意事项


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

80 评论
RYAN0UP • 2019-02-11
回复 删除

在焦点处插入内容应该是 insertValue 吧

Vanessa • 2019-02-11
回复 删除
Vanessa • 2019-02-11
回复 删除

谢谢支持

RYAN0UP • 2019-02-11
回复 删除

晚点也在我的项目上试试,现在的 Markdown 编辑器不是功能不全就是 bug 多或者不维护

Vanessa • 2019-02-11
回复 删除

本来早就想抽出来的,要不在 B3log 开源的几个项目中维护很头痛。以后只需要维护一个,然后升级以下就好了。

Vanessa • 2019-02-11
回复 删除

本来早就想抽出来的,要不在 B3log 开源的几个项目中维护很头痛。以后只需要维护一个,然后升级以下就好了。

Today • 2019-02-11
回复 删除

终于等到你😄

Today • 2019-02-11
回复 删除

终于等到你😄

KevinBlandy • 2019-02-12
回复 删除

编辑器现在markdownhtml的转换是由后端完成的吗?是否有计划实现让前端渲染,并且提供获取到渲染后 html 的接口。这样后端可以直接保存 html 数据。

很不错的编辑器,用着舒服。

88250 • 2019-02-12
回复 删除

暂时没有前端渲染 md 的计划,主要是前端渲染会有些问题:

  1. 有的业务逻辑是要后端查库的,比如渲染投票
  2. 安全校验需要后端来做,只靠前端会被绕过
  3. 后端渲染才能保证最终效果的一致

但前端可以做一些格式方面的功能,比如 md 格式化、Lint、语法检查。我们正在用 golang 写一个 md 引擎(项目代号 Lute),打算通过 WASM 把这样的功能提供给 JS,在前端做文本格式方面的辅助,让用户可以更好地使用 Vditor。

眼目前,做后端 Markdown 渲染 HTML 可以用 marked(或者用我们包装的 http-marked),这是我们目前测试下来渲染 md 最好的库。

Vanessa • 2019-02-12
回复 删除

过年的时候都没给自己放假 😭

Vanessa • 2019-02-12
回复 删除
An • 2019-02-12
回复 删除

大 V 都开始写编辑器了

Vanessa • 2019-02-12
回复 删除

再开一个新坑。一个萝卜一个坑。

KevinBlandy • 2019-02-12
回复 删除

在文本数据比较大的情况下,每一次的输入事件。都要把整个 markdown 文本提交给后台解析。这样是不是有点儿伤哦?其实我自己的想法非常简单。

  • 前端直接就完成了 markdownhtml 的转换,并且提供 API 获取到 html 数据。
  • 后端保存数据的时候,保存 html 以及 markdown 数据。
  • 查看文章的时候,从 DB 读取和渲染 html
  • 编辑文章的时候,从 DB 读取 markdown 渲染到编辑器。
  • Xss 安全问题,可以用 jsoup 来过滤 html 中的非法 标签属性 等。

我的想法有啥问题,D 哥指教一下。