Vditor 一款浏览器端的 Markdown 编辑器,支持所见即所得(富文本)、即时渲染(类似 Typora)和分屏预览模式

本贴最后更新于 333 天前,其中的信息可能已经沧海桑田

Vditor
易于使用的 Markdown 编辑器,为适配不同的应用场景而生

npm bundle size



English  |  Demo

💡 简介

Vditor 是一款浏览器端的 Markdown 编辑器,支持所见即所得、即时渲染(类似 Typora)和分屏预览模式。它使用 TypeScript 实现,支持原生 JavaScript、Vue、React、Angular,提供桌面版

欢迎到 Vditor 官方讨论区了解更多。同时也欢迎关注 B3log 开源社区微信公众号 B3log开源

b3logos.jpg

🗺️ 背景

随着 Markdown 排版方式的普及,越来越多的应用开始集成 Markdown 编辑器。目前主流可集成的 Markdown 编辑器现状如下:

而这三点恰好对应了三种应用场景:

所以,一个能够适配应用场景的 Markdown 编辑器至关重要,它需要考虑到:

Vditor 在这些方面做了努力,希望能为现代化的通用 Markdown 编辑领域做出一些贡献。

✨ 特性

editor.png

preview.png

🔮 编辑模式

所见即所得(WYSIWYG)

所见即所得模式对不熟悉 Markdown 的用户较为友好,熟悉 Markdown 的话也可以无缝使用。

vditor-wysiwyg

即时渲染(IR)

即时渲染模式对熟悉 Typora 的用户应该不会感到陌生,理论上这是最优雅的 Markdown 编辑方式。

vditor-ir

分屏预览(SV)

传统的分屏预览模式适合大屏下的 Markdown 编辑。

vditor-sv

🍱 语法支持

以上大部分特性可以通过开关配置是否启用,开发者可根据自己的应用场景选择搭配。

🗃 案例

🛠️ 使用文档

CommonJS

npm install vditor --save
import Vditor from 'vditor'
import "~vditor/src/assets/scss/index"

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

HTML script

<!-- ⚠️生产环境请指定版本号,如 https://cdn.jsdelivr.net/npm/vditor@x.x.x/dist... -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/vditor/dist/index.css" />
<script src="https://cdn.jsdelivr.net/npm/vditor/dist/index.min.js"></script>

示例代码

主题

编辑器主题

编辑器所展现的外观。内置 classic,dark 2 套主题。

内容主题

Markdown 输出的 HTML 所展现的外观。内置 light,dark,wechat 3 套主题。支持内容主题扩展接口。

代码主题

代码块所展现的外观。内置 github 等 36 套主题。

API

id

可填入元素 id 或元素自身 HTMLElement

⚠️:当填入元素自身的 HTMLElement 时需设置 options.cache.id 或将 options.cache.enable 设置为 false

options

说明 默认值
undoDelay 历史记录间隔 -
after 编辑器异步渲染完成后的回调方法 -
height 编辑器总高度 'auto'
minHeight 编辑区域最小高度 -
width 编辑器总宽度,支持 % 'auto'
placeholder 输入区域为空时的提示 ''
lang 多语言:en_US, ja_JP, ko_KR, zh_CN 'zh_CN'
input(value: string) 输入后触发 -
focus(value: string) 聚焦后触发 -
blur(value: string) 失焦后触发 -
esc(value: string) esc 按下后触发 -
ctrlEnter(value: string) ⌘/ctrl+enter 按下后触发 -
select(value: string) 编辑器中选中文字后触发 -
tab tab 键操作字符串,支持 \t 及任意字符串 -
typewriterMode 是否启用打字机模式 false
cdn 配置自建 CDN 地址 https://cdn.jsdelivr.net/npm/vditor@${VDITOR_VERSION}
mode 可选模式:sv, ir, wysiwyg 'ir'
debugger 是否显示日志 false
value 编辑器初始化值 ''
theme 主题:classic, dark 'classic'
icon 图标风格:ant, material 'ant'

options.toolbar

new Vditor('vditor', {
  toolbar: [
    {
      hotkey: '⇧⌘S',
      name: 'sponsor',
      tipPosition: 's',
      tip: '成为赞助者',
      className: 'right',
      icon: '<svg t="1589994565028" class="icon" viewBox="0 0 1024 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="2808" width="32" height="32"><path d="M506.6 423.6m-29.8 0a29.8 29.8 0 1 0 59.6 0 29.8 29.8 0 1 0-59.6 0Z" fill="#0F0F0F" p-id="2809"></path><path d="M717.8 114.5c-83.5 0-158.4 65.4-211.2 122-52.7-56.6-127.7-122-211.2-122-159.5 0-273.9 129.3-273.9 288.9C21.5 562.9 429.3 913 506.6 913s485.1-350.1 485.1-509.7c0.1-159.5-114.4-288.8-273.9-288.8z" fill="#FAFCFB" p-id="2810"></path><path d="M506.6 926c-22 0-61-20.1-116-59.6-51.5-37-109.9-86.4-164.6-139-65.4-63-217.5-220.6-217.5-324 0-81.4 28.6-157.1 80.6-213.1 53.2-57.2 126.4-88.8 206.3-88.8 40 0 81.8 14.1 124.2 41.9 28.1 18.4 56.6 42.8 86.9 74.2 30.3-31.5 58.9-55.8 86.9-74.2 42.5-27.8 84.3-41.9 124.2-41.9 79.9 0 153.2 31.5 206.3 88.8 52 56 80.6 131.7 80.6 213.1 0 103.4-152.1 261-217.5 324-54.6 52.6-113.1 102-164.6 139-54.8 39.5-93.8 59.6-115.8 59.6zM295.4 127.5c-72.6 0-139.1 28.6-187.3 80.4-47.5 51.2-73.7 120.6-73.7 195.4 0 64.8 78.3 178.9 209.6 305.3 53.8 51.8 111.2 100.3 161.7 136.6 56.1 40.4 88.9 54.8 100.9 54.8s44.7-14.4 100.9-54.8c50.5-36.3 108-84.9 161.7-136.6 131.2-126.4 209.6-240.5 209.6-305.3 0-74.9-26.2-144.2-73.7-195.4-48.2-51.9-114.7-80.4-187.3-80.4-61.8 0-127.8 38.5-201.7 117.9-2.5 2.6-5.9 4.1-9.5 4.1s-7.1-1.5-9.5-4.1C423.2 166 357.2 127.5 295.4 127.5z" fill="#141414" p-id="2811"></path><path d="M353.9 415.6m-33.8 0a33.8 33.8 0 1 0 67.6 0 33.8 33.8 0 1 0-67.6 0Z" fill="#0F0F0F" p-id="2812"></path><path d="M659.3 415.6m-33.8 0a33.8 33.8 0 1 0 67.6 0 33.8 33.8 0 1 0-67.6 0Z" fill="#0F0F0F" p-id="2813"></path><path d="M411.6 538.5c0 52.3 42.8 95 95 95 52.3 0 95-42.8 95-95v-31.7h-190v31.7z" fill="#5B5143" p-id="2814"></path><path d="M506.6 646.5c-59.6 0-108-48.5-108-108v-31.7c0-7.2 5.8-13 13-13h190.1c7.2 0 13 5.8 13 13v31.7c0 59.5-48.5 108-108.1 108z m-82-126.7v18.7c0 45.2 36.8 82 82 82s82-36.8 82-82v-18.7h-164z" fill="#141414" p-id="2815"></path><path d="M450.4 578.9a54.7 27.5 0 1 0 109.4 0 54.7 27.5 0 1 0-109.4 0Z" fill="#EA64F9" p-id="2816"></path><path d="M256 502.7a32.1 27.5 0 1 0 64.2 0 32.1 27.5 0 1 0-64.2 0Z" fill="#EFAFF9" p-id="2817"></path><path d="M703.3 502.7a32.1 27.5 0 1 0 64.2 0 32.1 27.5 0 1 0-64.2 0Z" fill="#EFAFF9" p-id="2818"></path></svg>',
      click () {alert('捐赠地址:https://ld246.com/sponsor')},
    }],
})
说明 默认值
name 唯一标示 -
icon svg 图标 -
tip 提示 -
tipPosition 提示位置:'n', 'ne', 'nw', 's', 'se', 'sw', 'w', 'e' -
hotkey 快捷键,格式为⇧⌘//⌥⌘ -
suffix 插入编辑器中的后缀 -
prefix 插入编辑器中的前缀 -
click(event: Event, vditor: IVditor) 自定义按钮点击时触发的事件 -
className 样式名 ''
toolbar?: Array<options.toolbar> 子菜单 -

options.toolbarConfig

说明 默认值
hide 是否隐藏工具栏 false
pin 是否固定工具栏 false

options.counter

说明 默认值
enable 是否启用计数器 false
tipPosition(length: number, counter: options.counter): void 字数统计回调 -
max 允许输入的最大值 -
type 统计类型:'markdown', 'text' 'markdown'

options.cache

说明 默认值
enable 是否使用 localStorage 进行缓存 true
id 缓存 key,第一个参数为元素且启用缓存时必填 -
after(html: string): string 缓存后的回调 -

options.comment

⚠️:仅支持 wysiwyg 模式

说明 默认值
enable 是否启用评论模式 false
add(id: string, text: string, commentsData: ICommentsData[]) 添加评论回调 -
remove(ids: string[]) 删除评论回调 -
scroll(top: number) 滚动回调 -
adjustTop(commentsData: ICommentsData[]) 文档修改时,适配评论高度 -

options.preview

说明 默认值
delay 预览 debounce 毫秒间隔 1000
maxWidth 预览区域最大宽度 800
mode 显示模式:both, editor 'both'
url md 解析请求 -
parse(element: HTMLElement) 预览回调 -
transform(html: string): string 渲染之前回调 -

options.preview.hljs

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

options.preview.markdown

说明 默认值
autoSpace 自动空格 false
fixTermTypo 自动矫正术语 false
toc 插入目录 false
footnotes 脚注 true
codeBlockPreview wysiwyg 和 ir 模式下是否对代码块进行渲染 true
mathBlockPreview wysiwyg 和 ir 模式下是否对数学公式进行渲染 true
paragraphBeginningSpace 段落开头空两个 false
sanitize 是否启用过滤 XSS true
listStyle 为列表添加 data-style 属性 false
linkBase 链接相对路径前缀 ''
linkPrefix 链接强制前缀 ''
mark 启用 mark 标记 false

options.preview.theme

说明 默认值
current 当前主题 "light"
list 可选主题列表 { dark: "Dark", light: "Light", wechat: "WeChat" }
path 主题样式地址 https://cdn.jsdelivr.net/npm/vditor@${VDITOR_VERSION}/dist/css/content-theme

options.preview.math

说明 默认值
inlineDigit 内联数学公式起始 $ 后是否允许数字 false
macros 使用 MathJax 渲染时传入的宏定义 {}
engine 数学公式渲染引擎:KaTeX, MathJax 'KaTeX'

options.preview.actions?: Array<IPreviewAction | IPreviewActionCustom>

默认值为 ["desktop", "tablet", "mobile", "mp-wechat", "zhihu"]。
可从默认值中挑选进行配置,也可使用以下字段进行自定制开发。

说明 默认值
key 按钮唯一标识,不能为空 -
text 按钮文字 -
tooltip 提示 -
className 按钮类名 -
click(key: string) 按钮点击回调事件 -

options.hint

说明 默认值
parse 是否进行 md 解析 true
delay 提示 debounce 毫秒间隔 200
emoji 默认表情,可从 lute/emoji_map 中选取,也可自定义 { '+1': '👍', '-1': '👎', 'heart': '❤️', 'cold_sweat': '😰' }
emojiTail 常用表情提示 -
emojiPath 表情图片地址 https://cdn.jsdelivr.net/npm/vditor@${VDITOR_VERSION}/dist/images/emoji
extend: IHintExtend[] 对 @/话题等关键字自动补全的扩展 []
interface IHintExtend {
    key: string;

    hint?(value: string): Array<{
        html: string;
        value: string;
    }>;
}

options.upload

// POST data  
xhr.send(formData);  // formData = FormData.append("file[]", File)  
// return data  
{  
 "msg": "",  
 "code": 0,  
 "data": {  
 "errFiles": ['filename', 'filename2'],  
 "succMap": {  
   "filename3": "filepath3",  
   "filename3": "filepath3"  
   }  
 }  
}
// POST data  
xhr.send(JSON.stringify({url: src})); // src 为站外图片地址  
// return data  
{  
 msg: '',  
 code: 0,  
 data : {  
   originalURL: '',  
   url: ''  
 }  
}
if (xhr.status === 200) {
    if (vditor.options.upload.success) {
        vditor.options.upload.success(editorElement, xhr.responseText);
    } else {
        let responseText = xhr.responseText;
        if (vditor.options.upload.format) {
            responseText = vditor.options.upload.format(files as File [], xhr.responseText);
        }
        genUploadedLabel(responseText, vditor);
    }
} else {
    if (vditor.options.upload.error) {
        vditor.options.upload.error(xhr.responseText);
    } else {
        vditor.tip.show(xhr.responseText);
    }
}
说明 默认值
url 上传 url ''
max 上传文件最大 Byte 10 * 1024 * 1024
linkToImgUrl 剪切板中包含图片地址时,使用此 url 重新上传 ''
linkToImgCallback(responseText: string) 图片地址上传回调 -
linkToImgFormat(responseText: string): string 对图片地址上传的返回值进行格式化 -
success(editor: HTMLPreElement, msg: string) 上传成功回调 -
error(msg: string) 上传失败回调 -
token CORS 上传验证,头为 X-Upload-Token -
withCredentials 跨站点访问控制 false
headers 请求头设置 -
filename(name: string): string 文件名安全处理 name => name.replace(/\W/g, '')
accept 文件上传类型,同 input accept -
validate(files: File[]) => string | boolean 校验,成功时返回 true 否则返回错误信息 -
handler(files: File[]) => string | null 自定义上传,当发生错误时返回错误信息 -
format(files: File[], responseText: string): string 对服务端返回的数据进行转换,以满足内置的数据结构 -
file(files: File[]): File[] 将上传的文件处理后再返回 -
setHeaders(): { [key: string]: string } 上传前使用返回值设置头 -
extraData: { [key: string]: string | Blob } 为 FormData 添加额外的参数 -
multiple 上传文件是否为多个 true
fieldName 上传字段名称 'file[]'

options.resize

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

options.classes

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

options.fullscreen

说明 默认值
index 全屏层级 90

options.outline

说明 默认值
enable 初始化是否展现大纲 false
position 大纲位置:'left', 'right' 'left'

methods

说明
getValue() 获取 Markdown 内容
getHTML() 获取 HTML 内容
insertValue(value: string, render = true) 在焦点处插入内容,并默认进行 Markdown 渲染
focus() 聚焦到编辑器
blur() 让编辑器失焦
disabled() 禁用编辑器
enable() 解除编辑器禁用
getSelection(): string 返回选中的字符串
setValue(markdown: string, clearStack = false) 设置编辑器内容且选中清空历史栈
clearStack() 清空撤销和重做记录栈
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: "both" | "editor") 设置预览模式
setTheme(theme: "dark" | "classic", contentTheme?: string, codeTheme?: string, contentThemePath?: string) 设置主题、内容主题及代码块风格
getCurrentMode(): string 获取编辑器当前编辑模式
destroy() 销毁编辑器
getCommentIds(): {id: string, top: number}[] 获取所有评论
hlCommentIds(ids: string[]) 高亮评论
unHlCommentIds(ids: string[]) 取消评论高亮
removeCommentIds(removeIds: string[]) 删除评论

static methods

Vditor.mermaidRender(document)
import VditorPreview from 'vditor/dist/method.min'  
VditorPreview.mermaidRender(document)
previewElement: HTMLDivElement,   // 使用该元素进行渲染
markdown: string,  // 需要渲染的 markdown 原文
options?: IPreviewOptions {
  mode: "dark" | "light";
  anchor?: number;  // 为标题添加锚点 0:不渲染;1:渲染于标题前;2:渲染于标题后,默认 0
  customEmoji?: { [key: string]: string };    // 自定义 emoji,默认为 {}  
  lang?: (keyof II18nLang);    // 语言,默认为 'zh_CN'  
  emojiPath?: string;    // 表情图片路径 
  hljs?: IHljs; // 参见 options.preview.hljs 
  speech?: {  // 对选中后的内容进行阅读
    enable?: boolean,
  };
  math?: IMath; // 数学公式渲染配置
  cdn?: string; // 自建 CDN 地址
  transform?(html: string): string; // 在渲染前进行的回调方法
  after?(); // 渲染完成后的回调
  lazyLoadImage?: string; // 设置为 Loading 图片地址后将启用图片的懒加载
  markdown?: options.preview.markdown;
  theme?: options.preview.theme;
  renderers?: ILuteRender; // 自定义渲染 https://ld246.com/article/1588412297062
}
说明
previewImage(oldImgElement: HTMLImageElement, lang: keyof II18n = "zh_CN", theme = "classic") 点击图片预览
mermaidRender(element: HTMLElement, cdn = options.cdn, theme = options.theme) 流程图/时序图/甘特图
flowchartRender(element: HTMLElement, cdn = options.cdn) flowchart 渲染
codeRender(element: HTMLElement, lang: (keyof II18nLang) = "zh_CN") 为 element 中的代码块添加复制按钮
chartRender(element: (HTMLElement | Document) = document, cdn = options.cdn, theme = options.theme) 图表渲染
mindmapRender(element: (HTMLElement | Document) = document, cdn = options.cdn, theme = options.theme) 脑图渲染
plantumlRender(element: (HTMLElement | Document) = document, cdn = options.cdn) plantuml 渲染
abcRender(element: (HTMLElement | Document) = document, cdn = options.cdn) 五线谱渲染
md2html(mdText: string, options?: IPreviewOptions): Promise<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
mathRender(element: HTMLElement, options?: {cdn?: string, math?: IMath}) 对数学公式进行渲染
speechRender(element: HTMLElement, lang?: (keyof II18nLang)) 对选中的文字进行阅读
graphvizRender(element: HTMLElement, cdn?: string) 对 graphviz 进行渲染
outlineRender(contentElement: HTMLElement, targetElement: Element) 对大纲进行渲染
lazyLoadImageRender(element: (HTMLElement | Document) = document) 对启用懒加载的图片进行渲染
setCodeTheme(codeTheme: string, cdn = options.cdn) 设置代码主题,codeTheme 参见 options.preview.hljs.style
setContentTheme(contentTheme: string, path: string) 设置内容主题,contentTheme 参见 options.preview.theme.list

🏗 开发文档

原理相关

环境

  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 的话,可按以下步骤进行操作:

升级

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

Ⓜ️ Markdown 使用指南

🏘️ 社区

📄 授权

Vditor 使用 MIT 开源协议。

🙏 鸣谢

📽️ 历史

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

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

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

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

于是,Vditor 就这样诞生了。

广告 我要投放

优质回帖
  • Vanessa 1
    订阅者 作者

    前端是这样传送的

        const formData = new FormData();
        for (let i = 0, iMax = uploadFileList.length; i < iMax; i++) {
            formData.append("file[]", uploadFileList[i]);
        }
         xhr.send(formData);
    
  • haaid 1

    文字错误:接触编辑器禁用,「接触」->「解除」

  • someone9891 1
    捐赠者

    此链接 404

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...
  • YangPC

    创建了一个 Vditor 学习交流群,欢迎有兴趣的兄弟姐妹加入:点击链接加入群聊【Vditor 学习交流 ① 群】:1055507442

  • YangPC

    建了一个 Vditor 学习交流群,欢迎有兴趣的兄弟姐妹加入:加入群聊【Vditor 学习交流 ① 群】:1055507442

    该回帖因偏离主题而被折叠
    1 操作
    Vanessa 在 2020-11-17 19:17:40 折叠了该回帖
  • dmbrave

    发现一个奇怪的事情,应该是一个渲染的 bug

    就是在编辑的时候,开启分屏预览模式时,输入诸如 <center>a</center> 这种非 html5 推荐的 html 标签的时候,在编辑器的预览里面,a 是不会居中的,但是在即时渲染模式下,这样输入会立即渲染成居中效果。
    类似的还有 <font> 类的标签,也是分屏预览的时候不会出效果,但是在即时渲染的时候,会出效果。
    这个还是挺奇怪的。

    a
  • dmbrave 1 评论

    发现一个奇怪的事情,应该是一个渲染的 bug

    就是在编辑的时候,开启分屏预览模式时,输入诸如 <center>a</center> 这种非 html5 推荐的 html 标签的时候,在编辑器的预览里面,a 是不会居中的,但是在即时渲染模式下,这样输入会立即渲染成居中效果。
    类似的还有 <font> 类的标签,也是分屏预览的时候不会出效果,但是在即时渲染的时候,会出效果。
    这个还是挺奇怪的。

    而在实际的发表之后的渲染中,也不支持这类标签,和即时渲染时的效果以及绝大多数 md 平台不一样,其他 md 平台大多都支持,是 lute 引擎的原因吗?能否优化呢?@Vanessa 希望关注,谢谢

    社区里面做了一些过滤,可以在 https://b3log.org/vditor/demo/option-mode.html 尝试
    Vanessa
  • qiqizyj 1 评论

    markdown 渲染 表格 表头留白咋实现呢 ,求大佬指点 ,我实在是没找着。

    不太明白表头留白是什么
    Vanessa
  • gztrljh 1 评论

    我想问问,Vditor 在入库的时候,是用 getValue() 还是 getHTML()呢?还有文章显示的时候是要引入 index.js 还是 method.min.js 呢?

    还有初始化的时候有这个提示,能够给它弄掉么?

    image.png

    1. getValue; 2. method.min.js; 3. 不能
    Vanessa
  • gztrljh 1 评论

    V 姐,这两天用了你的编辑器,感觉很棒,请问这个渲染后这一大堆提示信息怎么回事呢?我强迫症犯了,特别是其中还有个报错的,版本是 3.7.3

    image.png

    画图的日志信息,还没研究怎么关闭
    Vanessa
  • 547176052 1 评论

    image.png

    代码块这里 不显示复制图标

    image.png

    这是哪里?
    Vanessa
  • gztrljh 4 评论

    Vditor 已经玩的很熟悉了,感谢 Vditor,很棒,目前用过最好的 Markdown 编辑器,依我看,Markdown 以后会越来越火。这还有个小问题就是 ir 模式下那个表格点击无法显示源代码,是不是就是这样设计的呢?默认点击表格出来的是 3 行 3 列的,那我要是想再多加一列是否就要切换模式修改?

    目前可以使用快捷键
    Vanessa
    @Vanessa V 姐是否有计划 ir 模式下,点击表格也会出源码?因为我只喜欢 ir 模式。因为别的功能比如代码块还是别的图表都是点击可以回显源码进行修改的。
    gztrljh
    @Vanessa 还有表格如果太长的话会给 div 撑破了出现滚动条。能否想 bootstrap 那种响应式表格超出就出现滚动条那样的设计呢? ...
    gztrljh
    @gztrljh 可以使用快捷键切换到 sv 模式;表格太长会根据里面的内容进行自动折行,如果不能折行的话才会出现滚动条。如果有对比的可以截图给我参考一下,以便进行改进。
    Vanessa
  • gztrljh 2 评论

    bug 反馈.png

    完整示例中这种默认没有箭头,不同是同 ul 是通过 div 前面插入&nbsp 这种是怎么弄的呢?

    image.png

    线上还没有更新,请参照最新代码
    Vanessa
    @Vanessa 哦懂了,是默认 ul 有箭头那个效果才是最新版的效果嘛?因为我就是下载的 3.7.4 然后默认开启大纲,别的都没改。
    gztrljh
  • ieras 1 评论

    我很想知道,前端加了这个之后,后端存储的数据什么格式的呀?

    <?php
    echo "就是so吊!";
    
    后端可以使用 getValue 存储标准 md
    Vanessa
  • gztrljh

    image.png

    V 姐我格式这样传递不对吗?是按照官网进行返回的呀

    image.png

    前端返回数据

    image.png

    我就配置的单图上传

    image.png

    图片就是不出来

  • gztrljh

    哈哈,不好意思。返回要返回绝对路径,我返回了相对路径,已经成功上传图片。

    image.png

    有遇见的同学,可以把这个坑跳过去了。。

  • 547176052

    image.png

  • 547176052 2 评论

    image.png

    window.vditor.vditor.toolbar.elements.sponsor.children[0].classList.add("vditor-menu--disabled")
    Vanessa
    sponsor 为自定义按钮的 name
    Vanessa
  • gztrljh 1 评论

    3.7.5 在 npm 上没更新嘛?我下载还是 3.7.4

  • chenxiaobin 1 评论

    为什么我的大纲结构跟官方示例的不一样?这是怎么回事?有哪位知道吗?

    我的结构是这样的:

    <li>
    	<span data-target-id="wysiwyg-团队_0">
    		<svg class="vditor-outline__action"></svg>
    		<span>团队</span>
    	</span>
    </li>
    

    官方的是这样的:

    <div data-id="wysiwyg-教程_3" class="vditor-outline__item">  教程</div>
    
    官方的 demo 还没来得及更新到最新版,你的是正确的。
    Vanessa
  • gztrljh 1 评论

    image.png

    官网的默认的完整渲染示例,渲染大纲会出现如上错误

    就是这个代码

      const initOutline = () => {
        const headingElements = []
        Array.from(document.getElementById('preview').children).forEach((item) => {
          if (item.tagName.length === 2 && item.tagName !== 'HR' && item.tagName.indexOf('H') === 0) {
            headingElements.push(item)
          }
        })
    
        let toc = []
        window.addEventListener('scroll', () => {
          const scrollTop = window.scrollY
          toc = []
          headingElements.forEach((item) => {
            toc.push({
              id: item.id,
              offsetTop: item.offsetTop,
            })
          })
    
          const currentElement = document.querySelector('.vditor-outline__item--current')
          for (let i = 0, iMax = toc.length; i < iMax; i++) {
            if (scrollTop < toc[i].offsetTop - 30) {
              if (currentElement) {
                currentElement.classList.remove('vditor-outline__item--current')
              }
              let index = i > 0 ? i - 1 : 0
              document.querySelector('div[data-id="' + toc[index].id + '"]').classList.add('vditor-outline__item--current')
              break
            }
          }
        })
      }
    

    把渲染大纲部分给注释掉则不会报错了

    image.png

    image.png

    image.png

    请问 V 姐该怎么解决呢?

    多谢,官方稍后会更新一波
    Vanessa
  • gztrljh 1 评论

    image.png

    收到,下个版本修复
    Vanessa
  • gztrljh 1 评论

    image.png

    那个能科普一下这个打字机模式是什么意思嘛?百度了也没看懂。一般要设置成 true 还是 false 呢?🙏

    换行后光标会在文档中间
    Vanessa
  • chenxiaobin 1 评论

    上传的菜单按钮的 tip 提示:上传图片或文件 是否可以自定义?根据业务需求,只允许上传图片,但是描述与功能不符,是否可以改?

    可以的,参见 options.toolbar
    Vanessa
  • chuzhuang 1 评论

    我点击复制的时候,谷歌浏览器中出现以下,而且复制不成功

    image.png

    image.png

    你到 Demo 上试一下是否能重现
    Vanessa
  • chuzhuang 1 评论

    image.png

    您好,我用的是 demo,复制的时候会复现

    这个页面需要依赖 webpack server 的,不知道你怎么可以打开的。你先看一下 https://b3log.org/vditor/demo
    Vanessa
  • gztrljh

    那个能引入一个新的特性?给提示新增一个 z-index 配置项。。。

    image.png

    image.png

    1 回复
  • Vanessa
    订阅者 作者

    z-index 已经很高了,你这个应该是设置了 overflow: hidden
    image.png

  • dmbrave 2 评论

    为什么没有人反馈这个严重的问题,就是移动端看不到大纲啊!点击大纲,不知道大纲展示到哪里去了!

    1 回复
    可能移动端没人需要大纲吧
    Vanessa
    看了一下,是特意这么写的。大纲展现出来编辑器就没法看了,需要的话可以在外部单独加一个
    Vanessa
  • dmbrave 1 评论

    @Vanessa 为什么没有人反馈这个严重的问题,就是移动端看不到大纲啊!点击大纲,不知道大纲展示到哪里去了!

    然后刚刚又发现一个问题,我发表完回帖,点击编辑,编辑后无法提交

    有报错么?
    Vanessa
  • chuzhuang 1 评论

    全屏可以指定范围吗,比如在某个 div 中全屏

    不可以哦,这个就不叫全屏了
    Vanessa
  • chuzhuang 1 评论

    为什么第一次改变内容不允许撤销呢,第二次以后正常

    这个要怎么重现呢?
    Vanessa
  • chuzhuang 1 评论

    image.png

    关于这个我找到原因了,确实是代码的问题哈,dom 中已经写了复制的代码,但是下面又在事件里再次复制,如图

    image.png

    image.png

    我将下边的代码注释调就正常了,我觉得这是 bug 吧

    Vanessa
  • chuzhuang 1 评论

    问题:为什么第一次改变内容不允许撤销呢,第二次以后正常
    回复 1:这个怎么重现呢?
    打开编辑器,输入一个字符(有初始值时,修改一次也是),撤销应该把这个字符删掉,但是撤销是灰色的,ctrl+z 也不生效,再次输入或改变文字撤销生效

    setValue 后确实有点问题。下个版本修复
    Vanessa
  • gztrljh

    移动端大纲,肯定是自己布局啊。比如你可以来一个 pc 端,显示,移动端变成侧边栏菜单划出展示。手机本身就是屏幕小,用户体验不是很好,我在我的博客项目中明显,标注要想好的体验,请用 pc 访问。

  • gztrljh 1

    非常感谢能有这么好的编辑器能免费开源出来用,在很久以前确实都是在用富文本,但是感觉写作体验不是很好,二次开发对于主修后端的我来说,水平又不够,现在用 vditor 后发现体验真的好了很多很多。所以在使用的过程中,如果有任何缺陷我都将会及时提交到社区反馈,让 vditor 更加完善和富有生命力,非常感谢 vditor 的作者,反馈回复也很及时,真的很感谢。因为是免费用的,所以会有很多人反馈 bug,我觉得作者有的忙了。。。哈哈

  • Markyin 1 评论

    求教怎么在 VUE3.0 中使用

    Vanessa
  • Markyin 1 评论

    在 vue3.0 composition api 中,也是使用 onMounted 来引入 Vditor 吗?

    因为没有了 this,所以不太明白该使用那种方式来承载 Vditor,以及如何在表单中获取 Vditor 的值。

    请教下问什么有的组件使用 components 引用,有的是使用 onMounted 呢?

    1 回复
    获取值的话直接使用 getValue
    Vanessa
  • llej 1
    支持者 订阅者
  • chuzhuang 2 评论

    image.png

    我想请教一下,开启大纲时要注意什么吗,我设置开启后是空白的

                 outline: {
                        enable	:true,
                        position:'right'//, 'right'	'left'
                    },
    
    https://b3log.org/vditor/demo/advanced-outline.html 你在这里试一下,我重现不了
    Vanessa
    好像是我的其他样式对他干扰了,我再找找看,谢谢
    chuzhuang
  • RYANJ 2 评论

    为啥我的 outlineRender 字,图标都很大....

    微信图片 20210121220601.png

    1 操作
    RYANJ 在 2021-01-22 16:45:41 更新了该回帖
    看一下样式
    Vanessa
    设置一下 svg 的样式
    Vanessa
  • chuzhuang 3 评论

    我想问下,右边这个要怎么隐藏呢,可以设置隐藏的吗
    image.png

    不好意思,我又读了一遍文档,还是没找见如何隐藏,可以给个提示吗
    chuzhuang
    @chuzhuang options.preview.actions 设置为 [] 试试
    Vanessa
  • chuzhuang 2 评论

    今天刚发现的 bug,末尾插入行有问题,是起始插入了trollface

    具体说一下呗
    Vanessa
    不好意思,我觉得是我理解有问题,那两个按钮的作用是在光标所在行的起始或末尾插入,我以为是整个文档的起始或末尾
    chuzhuang
  • chuzhuang 2 评论

    image.png

    在创建多个实例时,页面由于只有一个该结点,所以只对一个编辑器进行销毁的时候不应该移除该节点,否则下次移除的时候就是 null,这个节点我看是一些 script,具体干嘛用的呢,不移除会不会有些影响

    换图标的时候用的。没有的时候会添加。是报错了,还是什么问题?
    Vanessa
    就是创建多个实例,再移除某个实例,或报错,提示这个节点不存在,因为第一次已经被移除了
    chuzhuang
  • gztrljh 1 评论

    我想问问这种场景,假如我把 csdn 的 markdown 文章 直接全选复制过来,假设文章中已经有很多图片了,复制到我自己的个人博客,可以把哪些图片自动上传到我们自己的服务器上么?

    编辑器包含了该功能,但主要还是要取决看你服务器是否可以访问 csdn 上的图片
    Vanessa
  • 547176052 1 评论

    image.png被挡住了

    使用 toolbar 对显示位置进行调整
    Vanessa
  • 547176052 1 评论

    image.png

    js 端

    image.png

    php 端

    image.png

    返回时 a => a.gif
    Vanessa
  • 547176052 1 评论

    image.png

    options.typewriterMode
    Vanessa
  • 547176052

    html 代码

    image.png

    js 代码

    image.png

  • 547176052 2 评论

    image.png

    Vanessa
    @Vanessa 管网好像也会 难道是浏览器的问题 我也能的是谷歌浏览器
    547176052
  • 547176052 1 评论

    image.png

    我这里没有报错,你的浏览器是?
    Vanessa
请输入回帖内容 ...