"Start CommonJS 安装依赖 npm install vditor --save 在代码中引入并初始化对象,可参考 [链接] import Vditor from 'vditor' @import '~vditor/src/assets/scss/classic' // 或者使用 dark const vdi .."

Vditor 使用指南

Start

CommonJS

npm install vditor --save
import Vditor from 'vditor'
@import "~vditor/src/assets/scss/classic" // 或者使用 dark

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

HTML script

<!-- 可使用 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()

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 -
editorName 设置编辑器中的 textarea name -
tab tab 键操作字符串,支持 \t 及任意字符串 -

options.toolbar

说明 默认值
name 唯一标示 -
icon svg 图标 -
tip 提示 -
tipPosition 提示位置:ne, nw -
hotkey 快捷键,目前仅支持 ctrl + 任意键 -
suffix 插入编辑器中的后缀 -
prefix 插入编辑器中的前缀 -

options.preview

说明 默认值
delay 预览 debounce 毫秒间隔 1000
show 是否显示预览区域 false
parse 预览回调 (element: HTMLElement): void -
url md 解析请求 -

options.preview.hljs

说明 默认值
enable 是否启用代码高亮 true
style highlight.js 样式文件名 'atom-one-light'

options.hint

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

options.upload

说明 默认值
url 上传 url,查看规范 ''
max 上传文件最大 Byte 10 * 1024 * 1024
linkToImgUrl 剪切板中包含图片地址时,使用此 url 重新上传 ''
success 上传成功回调 (textarea: HTMLTextAreaElement, 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 -

options.resize

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

options.classes

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

methods

说明
getValue() 获取编辑器内容
getHTML(includeHljs?: boolean) 获取预览区内容(是否输出代码高亮)。该方法需使用异步编程
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。该方法需使用异步编程

static methods

说明
mathRender(element: HTMLElement) 转换 element 中的文本为数学公式
mermaidRender(element: HTMLElement) 转换 element 中的文本为流程图 / 时序图 / 甘特图
codeRender(element: HTMLElement, lang: (keyof II18nLang)) 为 element 中的代码块添加复制按钮

CSS

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

Dev

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

注意事项:

  • Vditor

    Vditor 是一款浏览器端的 Markdown 编辑器,使用 TypeScript 实现。

    9 引用 • 92 回帖 • 9 关注
  • B3log

    B3log 是一个开源组织,名字来源于“Bulletin Board Blog”缩写,目标是将独立博客与论坛结合,形成一种新的网络社区体验,详细请看 B3log 构思。目前 B3log 已经开源了多款产品:PipeSoloSymWide 等,欢迎大家加入,贡献开源。

    2394 引用 • 3795 回帖 • 622 关注
  • 开发指南
    3 引用 • 97 回帖
感谢    关注    收藏    赞同    反对    举报    分享
34 回帖    
请输入回帖内容...
  • someone11732   1 感谢      

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

    1 回复 
    感谢    赞同    反对    举报    分享       评论    回复
  • Vanessa            
    1 回复 
    感谢    赞同    反对    举报    分享       评论    回复
  • someone11732            

    哈哈,Vditor 很棒!

    1 回复 
    感谢    赞同    反对    举报    分享       评论    回复
  • Vanessa            

    谢谢支持

    1 回复 
    感谢    赞同    反对    举报    分享       评论    回复
  • someone11732            

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

    1 回复 
    感谢    赞同    反对    举报    分享       评论    回复
  • Vanessa            

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

    感谢    赞同    反对    举报    分享       评论    回复
  • Today      

    终于等到你😄

    1 回复 
    感谢    赞同    反对    举报    分享       评论    回复
  • KevinBlandy      

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

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

    2 回复 
    感谢    赞同    反对    举报    分享       评论    回复
  • 88250            

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

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

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

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

    1 回复 
    感谢    赞同    反对    举报    分享       评论    回复
  • Vanessa            

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

    感谢    赞同    反对    举报    分享       评论    回复
  • Vanessa            
    感谢    赞同    反对    举报    分享       评论    回复
  • An    

    大 V 都开始写编辑器了

    1 回复 
    感谢    赞同    反对    举报    分享       评论    回复
  • Vanessa            

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

    感谢    赞同    反对    举报    分享       评论    回复
  • KevinBlandy            

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

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

    我这种想法有啥问题么?D 哥指教一下。

    1 回复 
    感谢    赞同    反对    举报    分享       评论    回复
  • 88250            

    1. 预览和最终渲染效果会不一致,比如前端有的标签、属性没过滤而后端过滤了
    2. 不安全的 HTML 一旦入库,后面要更新就比较麻烦了

    所以我觉得后端渲染更好,性能问题不用太过担心,目前黑客派上面我还没发现 md 渲染慢,即使是边打字边看实时预览的情况。这一点其实很好理解,现在连编程语言的自动完成都可以通过后端语言服务器来做,更何况 md 这样语法简单的文本。

    感谢    赞同    反对    举报    分享       评论    回复
  • q2484877      

    为啥预览窗口没作用啊?是少了什么东西吗?

    png

    感谢    赞同    反对    举报    分享       评论    回复
  • Vanessa      

    上传和 MD 解析的接口用的是第三方的。后期会内置 MD 解析。请关注 https://github.com/b3log/vditor/issues/9

    感谢    赞同    反对    举报    分享       评论    回复
  • q2484877      

    后端渲染的时候,时序图和流程图没法渲染啊,你们是怎么解决的? @Vanessa @88250

    1 回复 
    感谢    赞同    反对    举报    分享       评论    回复
  • 88250            

    这部分是在前端做的,后端 Markdown 只会渲染为代码块。

    1 回复 
    感谢    赞同    反对    举报    分享       评论    回复
  • q2484877            

    能告知渲染代码在哪吗?实在是找不到😂

    1 回复 
    感谢    赞同    反对    举报    分享       评论    回复
  • Vanessa            
    感谢    赞同    反对    举报    分享       评论    回复
  • someone39364      

    萌新问个问题,为什么我引入了 js 和 css,也初始化了,但是页面没有出来效果呢,是缺少什么依赖吗?

    1 回复 
    感谢    赞同    反对    举报    分享       评论    回复
  • Vanessa   1 感谢            

    看一下错误信息

    2 回复 
    感谢    赞同    反对    举报    分享       评论    回复
  • someone39364            

    显示未定义,image.png

    感谢    赞同    反对    举报    分享       评论    回复
  • someone39364            

    谢谢。知道了,我的错,我没有给 id 加引号😂

    感谢    赞同    反对    举报    分享       评论    回复
  • Eddie    

    好像渲染有点慢,是不是文本变化触发监听的事件不太对?

    1 回复 
    感谢    赞同    反对    举报    分享       评论    回复
  • Vanessa            

    是预览区的渲染,还是页面刷新后编辑器的渲染?

    1 回复 
    感谢    赞同    反对    举报    分享       评论    回复
  • Eddie          

    预览区啊,

    1 回复 
    感谢    赞同    反对    举报    分享       评论    回复
  • Vanessa            

    设置了 500 毫秒的延迟

    1 回复 
    感谢    赞同    反对    举报    分享       评论    回复
  • Eddie          

    这样啊,怪不得。。。

    1 回复 
    感谢    赞同    反对    举报    分享       评论    回复
  • Vanessa            

    默认是 1s。你的感知很灵敏呀

    感谢    赞同    反对    举报    分享       评论    回复
  • darren   2 感谢      

    目前正打算使用 vditor,但是发现一些地方不顺手,所以应该算是提出一些建议吧:

    • 服务器渲染预览时请求头的 content-type 希望能设置成 application/json 当前是 text/plain 导致像 SpringMVC 无法直接使用 @RequestBody
    • 文件上传的选择框 允许添加限定选择的文件类型(accept 属性)
    • 希望能添加前端浏览器渲染的功能(这样在有流量限制或者离线断网的环境也能愉快的编辑,别问我为什么有离线使用的情况,那就要问为啥有缓存这个功能呢?哈哈哈)
    • 希望能开放一些 api 供开发者直接调用,如 HTML 转 markdown 的方法(目前只能粘贴的时候转换),这样方便读取页面上原始的一段 HTML,转为 markdown 后直接编辑
    • 编辑器当前是以 div 这 dom 容器作为入口的,所以如果假设原始 div 容器中已经有内容了,希望能直接将原始容器中的 HTML 自动转 markdown 并作为默认值初始化给编辑器
    1 回复 
    感谢    赞同    反对    举报    分享       评论    回复
  • Vanessa            
    感谢    赞同    反对    举报    分享       评论    回复
  • BrickCat      

    自定义 ToolBar 时报错了TypeError: this.options.toolbar.forEach is not a function

    toolbar:{
            name:['emoji', 'br', 'bold', '|', 'line']
          },
    
    感谢    赞同    反对    举报    分享       评论    回复
    请如下使用 toolbar: ['emoji', 'br', 'bold', '|', 'line'],
    Vanessa
       感谢    @
请输入回帖内容...