Vditor 使用体验纪要

本贴最后更新于 1778 天前,其中的信息可能已经天翻地覆

故事背景

蛮早期就有关注到由黑客派所出品的 Vditor:一款为未来而构建的下一代 Markdown 编辑器。然,现而今市面上所存在的 Markdown 编辑器,或多或少都存在一些问题(或功能不全,或高级功能收费...),因此基于自身所需,加之 Vditor 的强大,就诞生了做一款在线 Markdown 编辑器的念头;取其名曰:Arya,个中原由,有在观《权利的游戏》感记一文有做记载。

最近因为频繁用到关于 Markdown,就断续利用一些业余时间,基于 VueVditor,将之前的想法给实践了下。这便是现在的 Arya - 在线 Markdown 编辑器;关于 Arya 的更多讯息,有在 https://hacpai.com/article/1558270349379 这一帖子中加以陈述;新开这篇帖子,在于记录一些关于 Vditor 使用的一些体验感受(陆续陆续记录 @Vanessa )。

  • 预览:这边想实现 About Arya 页面,翻越了 https://hacpai.com/article/1549638745630 ,并没有发现相关功能设定,就只好在页面渲染完毕后,将 Textarea 给隐藏来实现,代码见: markdown-online-editor;这相对会比较麻烦些,如果自带这个功能就更好了。
  • 编辑器左侧 md 语法高亮:有用户提到想要这个功能,个人觉得这个也是蛮有用,且会极大提升使用体验; @Vanessa 可以考虑注入这个功能么?(目前编辑区域基于 textarea 的话,不太好实现这个功能)。
  • 表格中代办事项:在有些场景下,表格中加入 代办事项 的功能,还是蛮有用的;目前看来是没有做解析,是不是可以考虑加上呢( @Vanessa ),如下语法示例:
| TODO | DOING | DONE |
| :---: | :---: | :---:  |
| - [ ] TODO | - [ ] DOING | - [x] DONE |
TODO DOING DONE
- [ ] TODO - [ ] DOING - [x] DONE
2 操作
jeffjade 在 2019-06-11 22:54:37 更新了该帖
jeffjade 在 2019-05-30 23:32:45 更新了该帖

相关帖子

欢迎来到这里!

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

注册 关于
请输入回帖内容 ...
  • 你看一下 https://hacpai.com/article/1549638745630#toc_h3_13 的静态方法,这样就不用去渲染编辑器了。

    • 使用 md2html 把 md 转换为 html
    • 使用 mathRender 转换数学公式
    • 使用 mermaidRender 转换图表
    • 使用 codeRender 为代码添加复制功能
    2 回复
  • jeffjade
    作者

    Wow,好的,我回去抽空体验下 👍👍👍。

  • jeffjade
    作者

    话说例如 md2html 这些静态方法,该如何使用呢?(查看了文档 & 粗略的看了下源码,并没有发现更多讯息来告知如何使用这个静态方法 😂 )。

    1 回复
  • 直接 Vditor.md2html('#hi')

    2 回复
  • jeffjade
    作者

    嗯,其实一上来,就有如此试过,但会报错:“vditor__WEBPACK_IMPORTED_MODULE_0___default.a.md2html is not a function”,所以~

    "vditor": "^1.3.5",

    我方才看了下,npm 上的版本已经到 1.4.4 了,我更新下看看(昨晚看 github releases 上的版本才 1.3.5)。

    1 回复
  • jeffjade
    作者

    嗯,果然是版本没跟上所致;更新到 1.4,4 可以了(建议可以在说明中,为属性 or 方法,加上对应的支持版本信息)。

    不过,会有如下一个报错;
    image.png
    可看了下源码, $toolTipBg 这个 css 变量是有定义的~

  • GitHub 上凑足几个 issue 才会 release 一个版本。$tooltipBg 这个改过大小写 trollface

    1 回复
  • jeffjade
    作者

    原来如此,了解了 👌 。$tooltipBg 这个变量,我这边使用时小做兼容下就好了。

  • jeffjade
    作者

    @Vanessa 受这个仓库的启发,markvis,Vditor 是不是也可以注入这些功能(暴露接口出来),使得用户可以在 markdown 中进行可视化呢。

    1 回复
  • 不错呀,vditor 现在还不支持 chart 呢。话说我可以不用查看其他的,直接使用你给的这个 markvis 么?

    1 回复
    2 操作
    Vanessa 在 2019-05-31 18:48:05 更新了该回帖
    Vanessa 在 2019-05-31 18:47:43 更新了该回帖
  • jeffjade 1
    作者

    我觉得这个,看起来还可以(当然,目前还没遇到过更多类似的封装)。

  • jeffjade
    作者

    编辑器左侧 md 语法高亮:有用户提到想要这个功能,个人觉得这个也是蛮有用,且会极大提升使用体验; @Vanessa 可以考虑注入这个功能么?(目前编辑区域基于 textarea 的话,不太好实现这个功能)。

    1 回复
  • 呃。这样的话可能要重新写了,多选什么的也就可以了。当初看了 GitHub 的 issue 也是个 textarea,然后就。。。。

    1 回复
  • jeffjade 1 评论
    作者

    嗯,那目前是如何计划的呢?❤️

    目前继续做小需求和细节完善。换 textarea 估计要下个月了
    Vanessa
  • DeskZq

    请问 Vditor 可以自定义 Markdown Css 样式么?

    1 回复
  • 88250

    实现 GFM 规范的 Markdown 解析器应该都不支持 表格中待办事项。因为表格虽然是块级元素但不是块容器,所以它不能容纳其他块级元素:

    Block-level elements cannot be inserted in a table

    具体规范细节可参考这里

    1 回复
  • markdown css 语法是什么?

  • jeffjade 1
    作者

    嗯嗯,如果费点气力的话,可以考虑用 Div 实现表格,应该就可以实现这个功能了。当然,这个功能并不是刚需,可以优先更加有意义的功能。

    1 操作
    jeffjade 在 2019-08-11 17:40:54 更新了该回帖
  • SXX19950910

    嘿嘿嘿

    1 回复
  • jeffjade
    作者

    ✋ 🤝 😋

  • huaxie2017 1 评论

    请问我调用 setValue('11')报错15737851791122.jpg

    你是紧接着 new 方法后调用么?如果是需要在 options.after 中进行调用
    Vanessa
  • huaxie2017

    是在编辑器初始化之后 其他操作需要给编辑器设置内容

  • huaxie2017

    大佬 我想请教下 编辑器编辑的文本保存后 怎么在页面上渲染出来呢

    1 回复
  • jeffjade
    作者

    指的是用 Vditor 么? “怎么在页面上渲染出来呢”,对于这句我可能没弄明白(Vditor 是可以直接渲染出来的)。

    1 回复
  • huaxie2017

    我的意思是编辑器提交的文本 需要在页面上输出 用的是 preview 在页面显示的内容

    1 回复
  • jeffjade
    作者

    意思是像这样个页面: https://markdown.lovejade.cn/about-arya ,只显示 Preview 内容,而不展示其他是么?

    如果是这样的话,我这边采取的办法是隐藏 Vditor 的 textarea,具体代码见:https://github.com/nicejade/markdown-online-editor/blob/15a3492a2ad19c0d902d47563a2611e2a5d8f55c/src/helper/utils.js#L93-L113

    1 回复
  • huaxie2017

    是的 保存的内容在页面渲染出来 已解决 谢谢大佬

    1 回复
  • jeffjade
    作者

    好的。 🤝 🤝

请输入回帖内容 ...
jeffjade
在职程序员,晚晴幽草轩轩主,倾城之链开发者 深圳

推荐标签 标签

  • Markdown

    Markdown 是一种轻量级标记语言,用户可使用纯文本编辑器来排版文档,最终通过 Markdown 引擎将文档转换为所需格式(比如 HTML、PDF 等)。

    163 引用 • 1450 回帖
  • 博客

    记录并分享人生的经历。

    270 引用 • 2386 回帖
  • Firefox

    Mozilla Firefox 中文俗称“火狐”(正式缩写为 Fx 或 fx,非正式缩写为 FF),是一个开源的网页浏览器,使用 Gecko 排版引擎,支持多种操作系统,如 Windows、OSX 及 Linux 等。

    7 引用 • 30 回帖 • 452 关注
  • 创业

    你比 99% 的人都优秀么?

    82 引用 • 1398 回帖
  • 微软

    微软是一家美国跨国科技公司,也是世界 PC 软件开发的先导,由比尔·盖茨与保罗·艾伦创办于 1975 年,公司总部设立在华盛顿州的雷德蒙德(Redmond,邻近西雅图)。以研发、制造、授权和提供广泛的电脑软件服务业务为主。

    8 引用 • 44 回帖
  • Webswing

    Webswing 是一个能将任何 Swing 应用通过纯 HTML5 运行在浏览器中的 Web 服务器,详细介绍请看 将 Java Swing 应用变成 Web 应用

    1 引用 • 15 回帖 • 635 关注
  • DNSPod

    DNSPod 建立于 2006 年 3 月份,是一款免费智能 DNS 产品。 DNSPod 可以为同时有电信、网通、教育网服务器的网站提供智能的解析,让电信用户访问电信的服务器,网通的用户访问网通的服务器,教育网的用户访问教育网的服务器,达到互联互通的效果。

    6 引用 • 26 回帖 • 522 关注
  • Ngui

    Ngui 是一个 GUI 的排版显示引擎和跨平台的 GUI 应用程序开发框架,基于
    Node.js / OpenGL。目标是在此基础上开发 GUI 应用程序可拥有开发 WEB 应用般简单与速度同时兼顾 Native 应用程序的性能与体验。

    7 引用 • 9 回帖 • 346 关注
  • jsDelivr

    jsDelivr 是一个开源的 CDN 服务,可为 npm 包、GitHub 仓库提供免费、快速并且可靠的全球 CDN 加速服务。

    5 引用 • 31 回帖 • 42 关注
  • Sym

    Sym 是一款用 Java 实现的现代化社区(论坛/BBS/社交网络/博客)系统平台。

    下一代的社区系统,为未来而构建

    523 引用 • 4581 回帖 • 690 关注
  • MyBatis

    MyBatis 本是 Apache 软件基金会 的一个开源项目 iBatis,2010 年这个项目由 Apache 软件基金会迁移到了 google code,并且改名为 MyBatis ,2013 年 11 月再次迁移到了 GitHub。

    170 引用 • 414 回帖 • 430 关注
  • Solo

    Solo 是一款小而美的开源博客系统,专为程序员设计。Solo 有着非常活跃的社区,可将文章作为帖子推送到社区,来自社区的回帖将作为博客评论进行联动(具体细节请浏览 B3log 构思 - 分布式社区网络)。

    这是一种全新的网络社区体验,让热爱记录和分享的你不再感到孤单!

    1425 引用 • 10043 回帖 • 470 关注
  • OAuth

    OAuth 协议为用户资源的授权提供了一个安全的、开放而又简易的标准。与以往的授权方式不同之处是 oAuth 的授权不会使第三方触及到用户的帐号信息(如用户名与密码),即第三方无需使用用户的用户名与密码就可以申请获得该用户资源的授权,因此 oAuth 是安全的。oAuth 是 Open Authorization 的简写。

    36 引用 • 103 回帖 • 9 关注
  • ZeroNet

    ZeroNet 是一个基于比特币加密技术和 BT 网络技术的去中心化的、开放开源的网络和交流系统。

    1 引用 • 21 回帖 • 590 关注
  • 小说

    小说是以刻画人物形象为中心,通过完整的故事情节和环境描写来反映社会生活的文学体裁。

    28 引用 • 108 回帖
  • Swift

    Swift 是苹果于 2014 年 WWDC(苹果开发者大会)发布的开发语言,可与 Objective-C 共同运行于 Mac OS 和 iOS 平台,用于搭建基于苹果平台的应用程序。

    34 引用 • 37 回帖 • 497 关注
  • 黑曜石

    黑曜石是一款强大的知识库工具,支持本地 Markdown 文件编辑,支持双向链接和关系图。

    A second brain, for you, forever.

    10 引用 • 85 回帖
  • FlowUs

    FlowUs.息流 个人及团队的新一代生产力工具。

    让复杂的信息管理更轻松、自由、充满创意。

    1 引用
  • Vditor

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

    312 引用 • 1666 回帖 • 1 关注
  • 面试

    面试造航母,上班拧螺丝。多面试,少加班。

    324 引用 • 1395 回帖
  • 友情链接

    确认过眼神后的灵魂连接,站在链在!

    24 引用 • 373 回帖 • 1 关注
  • PWL

    组织简介

    用爱发电 (Programming With Love) 是一个以开源精神为核心的民间开源爱好者技术组织,“用爱发电”象征开源与贡献精神,加入组织,代表你将遵守组织的“个人开源爱好者”的各项条款。申请加入:用爱发电组织邀请帖
    用爱发电组织官网:https://programmingwithlove.stackoverflow.wiki/

    用爱发电组织的核心驱动力:

    • 遵守开源守则,体现开源&贡献精神:以分享为目的,拒绝非法牟利。
    • 自我保护:使用适当的 License 保护自己的原创作品。
    • 尊重他人:不以各种理由、各种漏洞进行未经允许的抄袭、散播、洩露;以礼相待,尊重所有对社区做出贡献的开发者;通过他人的分享习得知识,要留下足迹,表示感谢。
    • 热爱编程、热爱学习:加入组织,热爱编程是首当其要的。我们欢迎热爱讨论、分享、提问的朋友,也同样欢迎默默成就的朋友。
    • 倾听:正确并恳切对待、处理问题与建议,及时修复开源项目的 Bug ,及时与反馈者沟通。不抬杠、不无视、不辱骂。
    • 平视:不诋毁、轻视、嘲讽其他开发者,主动提出建议、施以帮助,以和谐为本。只要他人肯努力,你也可能会被昔日小看的人所超越,所以请保持谦虚。
    • 乐观且活跃:你的努力决定了你的高度。不要放弃,多年后回头俯瞰,才会发现自己已经成就往日所仰望的水平。积极地将项目开源,帮助他人学习、改进,自己也会获得相应的提升、成就与成就感。
    1 引用 • 487 回帖 • 9 关注
  • 音乐

    你听到信仰的声音了么?

    59 引用 • 509 回帖
  • QQ

    1999 年 2 月腾讯正式推出“腾讯 QQ”,在线用户由 1999 年的 2 人(马化腾和张志东)到现在已经发展到上亿用户了,在线人数超过一亿,是目前使用最广泛的聊天软件之一。

    45 引用 • 557 回帖 • 222 关注
  • Bug

    Bug 本意是指臭虫、缺陷、损坏、犯贫、窃听器、小虫等。现在人们把在程序中一些缺陷或问题统称为 bug(漏洞)。

    77 引用 • 1741 回帖 • 1 关注
  • Sandbox

    如果帖子标签含有 Sandbox ,则该帖子会被视为“测试帖”,主要用于测试社区功能,排查 bug 等,该标签下内容不定期进行清理。

    368 引用 • 1212 回帖 • 581 关注
  • 开源中国

    开源中国是目前中国最大的开源技术社区。传播开源的理念,推广开源项目,为 IT 开发者提供了一个发现、使用、并交流开源技术的平台。目前开源中国社区已收录超过两万款开源软件。

    7 引用 • 86 回帖