{"id":15033039,"url":"https://github.com/vanessa219/vditor","last_synced_at":"2025-05-12T05:15:24.567Z","repository":{"id":37270805,"uuid":"224841533","full_name":"Vanessa219/vditor","owner":"Vanessa219","description":"♏  一款浏览器端的 Markdown 编辑器，支持所见即所得（富文本）、即时渲染（类似 Typora）和分屏预览模式。An In-browser Markdown editor, support WYSIWYG (Rich Text),  Instant Rendering (Typora-like) and Split View modes.","archived":false,"fork":false,"pushed_at":"2025-04-09T07:54:42.000Z","size":27944,"stargazers_count":9300,"open_issues_count":98,"forks_count":927,"subscribers_count":69,"default_branch":"master","last_synced_at":"2025-05-12T05:14:54.521Z","etag":null,"topics":["commonmark","editor","gfm","lute","markdown","md","react","rich-text","typescript","typora","vue","wysiwyg"],"latest_commit_sha":null,"homepage":"https://b3log.org/vditor","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Vanessa219.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"custom":"https://ld246.com/sponsor","open_collective":"b3log"}},"created_at":"2019-11-29T11:30:51.000Z","updated_at":"2025-05-12T02:39:18.000Z","dependencies_parsed_at":"2022-07-14T04:50:29.305Z","dependency_job_id":"57c487e1-51a1-447a-9d75-55ad8c74f991","html_url":"https://github.com/Vanessa219/vditor","commit_stats":{"total_commits":2518,"total_committers":54,"mean_commits":"46.629629629629626","dds":0.4340746624305004,"last_synced_commit":"6409201c472f2b16ac3b5954bb1de0c57e40cd6a"},"previous_names":[],"tags_count":84,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vanessa219%2Fvditor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vanessa219%2Fvditor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vanessa219%2Fvditor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Vanessa219%2Fvditor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Vanessa219","download_url":"https://codeload.github.com/Vanessa219/vditor/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253678903,"owners_count":21946319,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["commonmark","editor","gfm","lute","markdown","md","react","rich-text","typescript","typora","vue","wysiwyg"],"created_at":"2024-09-24T20:19:57.109Z","updated_at":"2025-05-12T05:15:24.508Z","avatar_url":"https://github.com/Vanessa219.png","language":"TypeScript","funding_links":["https://ld246.com/sponsor","https://opencollective.com/b3log"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\u003cimg alt=\"Vditor\" src=\"https://b3log.org/images/brand/vditor-128.png\" /\u003e\n\n\u003cbr\u003e\n易于使用的 Markdown 编辑器，为适配不同的应用场景而生\n\u003cbr\u003e\u003cbr\u003e\n\u003ca title=\"MIT\" target=\"_blank\" href=\"https://opensource.org/licenses/MIT\"\u003e\u003cimg src=\"https://img.shields.io/badge/license-MIT-orange.svg?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca title=\"npm bundle size\" target=\"_blank\" href=\"https://www.npmjs.com/package/vditor\"\u003e\u003cimg alt=\"npm bundle size\" src=\"https://img.shields.io/bundlephobia/minzip/vditor?style=flat-square\u0026color=blueviolet\"\u003e\u003c/a\u003e\n\u003ca title=\"Version\" target=\"_blank\" href=\"https://www.npmjs.com/package/vditor\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/vditor.svg?style=flat-square\"\u003e\u003c/a\u003e\u003cbr\u003e\n\u003ca title=\"Downloads\" target=\"_blank\" href=\"https://www.npmjs.com/package/vditor\"\u003e\u003cimg src=\"https://img.shields.io/npm/dt/vditor.svg?style=flat-square\u0026color=97ca00\"\u003e\u003c/a\u003e\n\u003ca title=\"jsdelivr\" target=\"_blank\" href=\"https://www.jsdelivr.com/package/npm/vditor\"\u003e\u003cimg src=\"https://data.jsdelivr.com/v1/package/npm/vditor/badge\"/\u003e\u003c/a\u003e\n\u003ca title=\"Hits\" target=\"_blank\" href=\"https://github.com/88250/hits\"\u003e\u003cimg src=\"https://hits.b3log.org/Vanessa219/vditor.svg\"\u003e\u003c/a\u003e \u003cbr\u003e\u003cbr\u003e\n\u003ca title=\"GitHub Watchers\" target=\"_blank\" href=\"https://github.com/Vanessa219/vditor/watchers\"\u003e\u003cimg src=\"https://img.shields.io/github/watchers/Vanessa219/vditor.svg?label=Watchers\u0026style=social\"\u003e\u003c/a\u003e\n\u003ca title=\"GitHub Stars\" target=\"_blank\" href=\"https://github.com/Vanessa219/vditor/stargazers\"\u003e\u003cimg src=\"https://img.shields.io/github/stars/Vanessa219/vditor.svg?label=Stars\u0026style=social\"\u003e\u003c/a\u003e\n\u003ca title=\"GitHub Forks\" target=\"_blank\" href=\"https://github.com/Vanessa219/vditor/network/members\"\u003e\u003cimg src=\"https://img.shields.io/github/forks/Vanessa219/vditor.svg?label=Forks\u0026style=social\"\u003e\u003c/a\u003e\n\u003ca title=\"Author GitHub Followers\" target=\"_blank\" href=\"https://github.com/vanessa219\"\u003e\u003cimg src=\"https://img.shields.io/github/followers/vanessa219.svg?label=Followers\u0026style=social\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://github.com/Vanessa219/vditor/blob/master/README_en_US.md\"\u003eEnglish\u003c/a\u003e \u0026nbsp;|\u0026nbsp; \u003ca href=\"https://b3log.org/vditor/demo/index.html\"\u003eDemo\u003c/a\u003e\n\u003c/p\u003e\n\n## 💡 简介\n\n[Vditor](https://b3log.org/vditor) 是一款浏览器端的 Markdown 编辑器，支持所见即所得、即时渲染（类似 Typora）和分屏预览模式。它使用 TypeScript 实现，支持原生 JavaScript 以及 Vue、React、Angular 和 Svelte 等框架。\n\n欢迎到 [Vditor 官方讨论区](https://ld246.com/tag/vditor)了解更多。同时也欢迎关注 B3log 开源社区微信公众号 `B3log开源`：\n\n![b3logos.jpg](https://b3logfile.com/file/2020/08/b3logos-032af045.jpg)\n\n## 🗺️ 背景\n\n随着 Markdown 排版方式的普及，越来越多的应用开始集成 Markdown 编辑器。目前主流可集成的 Markdown 编辑器现状如下：\n\n* 有的仅支持分屏预览，即编辑区和预览区分离\n* 有的同时支持所见即所得和分屏预览，但所见即所得模式下不能完整支持 Markdown 语法排版\n* 几乎没有类似 Typora 的即时渲染\n\n而这三点恰好对应了三种应用场景：\n\n* 分屏预览：适配传统的 Markdown 使用场景，适合大屏下编辑排版\n* 所见即所得：对不熟悉 Markdown 的用户友好，熟悉 Markdown 的用户也可以无缝使用\n* 即时渲染：理论上这是最为优雅的 Markdown 编辑方式，让熟悉 Markdown 的用户能够更专注于内容创作\n\n所以，一个能够**适配应用场景**的 Markdown 编辑器至关重要，它需要考虑到：\n\n* 传统 Markdown 用户的使用场景，提供分屏预览\n* 富文本编辑用户的使用场景，提供所见即所得\n* 高阶 Markdown 用户的使用场景，提供即时渲染\n\nVditor 在这些方面做了努力，希望能为现代化的通用 Markdown 编辑领域做出一些贡献。\n\n## ✨  特性\n\n* 支持三种编辑模式：所见即所得（wysiwyg）、即时渲染（ir）、分屏预览（sv）\n* 支持大纲、数学公式、脑图、图表、流程图、甘特图、时序图、五线谱、[多媒体](https://ld246.com/article/1589813914768)、语音阅读、标题锚点、代码高亮及复制、graphviz 渲染、[plantuml](https://plantuml.com)UML图\n* 导出、图片懒加载、任务列表、多平台预览、多主题切换、复制到微信公众号/知乎功能\n* 实现 CommonMark 和 GFM 规范，可对 Markdown 进行格式化和语法树查看，并支持[10+项](https://ld246.com/article/1549638745630#options-preview-markdown)配置\n* 工具栏包含 36+ 项操作，除支持扩展外还可对每一项中的[快捷键](https://ld246.com/article/1582778815353)、提示、提示位置、图标、点击事件、类名、子工具栏进行自定义\n* 表情/at/话题等自动补全扩展\n* 可使用拖拽、剪切板粘贴上传，显示实时上传进度，支持 CORS 跨域上传\n* 实时保存内容，防止意外丢失\n* 录音支持，用户可直接发布语音\n* 粘贴 HTML 自动转换为 Markdown，如粘贴中包含外链图片可通过指定接口上传到服务器\n* 支持主窗口大小拖拽、字符计数\n* 多主题支持，内置黑白绿三套主题\n* 多语言支持，内置中、英、韩文本地化\n* 支持主流浏览器，对移动端友好\n\n![editor.png](https://b3logfile.com/file/2020/07/editor-b304aa97.png)\n\n![preview.png](https://b3logfile.com/file/2020/05/preview-80846f66.png)\n\n## 🔮 编辑模式\n\n### 所见即所得（WYSIWYG）\n\n*所见即所得*模式对不熟悉 Markdown 的用户较为友好，熟悉 Markdown 的话也可以无缝使用。\n\n![vditor-wysiwyg](https://b3logfile.com/file/2020/07/wysiwyg-4f216b9b.gif)\n\n### 即时渲染（IR）\n\n*即时渲染*模式对熟悉 Typora 的用户应该不会感到陌生，理论上这是最优雅的 Markdown 编辑方式。\n\n![vditor-ir](https://b3logfile.com/file/2020/07/ir-67cd956c.gif)\n\n### 分屏预览（SV）\n\n传统的*分屏预览*模式适合大屏下的 Markdown 编辑。\n\n![vditor-sv](https://b3logfile.com/file/2020/07/sv-595dcb28.gif)\n\n## 🍱 语法支持\n\n* 所有 CommonMark 语法：分隔线、ATX 标题、Setext 标题、缩进代码块、围栏代码块、HTML 块、链接引用定义、段落、块引用、列表、反斜杠转义、HTML 实体、行级代码、强调、加粗、链接、图片、行级 HTML、硬换行、软换行和纯文本。\n* 所有 GFM 语法：表格、任务列表项、删除线、自动链接、XSS 过滤\n* 常用 Markdown 扩展语法：脚注、ToC、自定义标题 ID\n* 图表语法\n  * 流程图、时序图、甘特图，通过 Mermaid 支持\n  * Graphviz\n  * 折线图、饼图、脑图等，通过 ECharts 支持\n* 五线谱：通过 abc.js 支持\n* 数学公式：数学公式块、行级数学公式，通过 MathJax 和 KaTeX 支持\n* YAML Front Matter\n* 中文语境优化\n  * 中西文之间插入空格\n  * 术语拼写修正\n  * 中文后跟英文逗号句号等标点替换为中文对应标点\n\n以上大部分特性可以通过开关配置是否启用，开发者可根据自己的应用场景选择搭配。\n\n## 🗃 案例\n\n* [Sym](https://github.com/88250/symphony) 一款用 Java 实现的现代化社区（论坛/BBS/社交网络/博客）平台\n* [Solo](https://github.com/88250/solo) \u0026 [Pipe](https://github.com/88250/pipe) B3log 分布式社区的博客端节点，欢迎加入下一代社区网络\n* [Tditor](https://tditor.com) 基于React、Vditor、Springboot，一款打造极致文字创作体验的在线Markdown编辑平台\n* [Arya](https://github.com/nicejade/markdown-online-editor) 基于 Vue、Vditor，所构建的在线 Markdown 编辑器\n* [更多案例](https://github.com/Vanessa219/vditor/network/dependents?package_id=UGFja2FnZS0zMTY2Mzg4MzE%3D)\n\n## 🛠️ 使用文档\n\n### CommonJS\n\n* 安装依赖\n\n```shell\nnpm install vditor --save\n```\n\n* 在代码中引入并初始化对象，可参考 [index.js](https://github.com/Vanessa219/vditor/blob/master/demo/index.js)\n\n```ts\nimport Vditor from 'vditor'\nimport \"~vditor/src/assets/less/index\"\n\nconst vditor = new Vditor(id, {options...})\n```\n\n### HTML script\n\n* 在 HTML 中插入 CSS 和 JavaScript，可参考 [demo](https://b3log.org/vditor/demo/index.html)\n\n```html\n\u003c!-- ⚠️生产环境请指定版本号，如 https://unpkg.com/vditor@x.x.x/dist... --\u003e\n\u003clink rel=\"stylesheet\" href=\"https://unpkg.com/vditor/dist/index.css\" /\u003e\n\u003cscript src=\"https://unpkg.com/vditor/dist/index.min.js\"\u003e\u003c/script\u003e\n```\n\n### 示例代码\n\n* [官方示例](https://b3log.org/vditor/demo/index.html) / [示例源码](https://github.com/Vanessa219/b3log-index/tree/master/src/vditor)\n* [CommonJS Editor](https://github.com/Vanessa219/vditor/blob/master/demo/index.js)\n* [CommonJS Render](https://github.com/Vanessa219/vditor/blob/master/demo/render.js)\n* [在Svelte中使用](https://github.com/HerbertHe/svelte-vditor-demo)\n\n### 主题\n\n#### 编辑器主题\n\n编辑器所展现的外观。内置classic，dark 2 套主题。\n\n* 编辑器初始化时可通过 `options.theme` 设置内置主题\n* 初始化完成后可通过 `setTheme` 更新编辑器主题\n* 可通过修改 [index.less](https://github.com/Vanessa219/vditor/blob/master/src/assets/less/index.less) 中的变量对主题颜色进行定制\n* 可参考现有结构和类名在原有基础上进行修改\n\n#### 内容主题\n\nMarkdown 输出的 HTML 所展现的外观。内置 ant-design, light，dark，wechat 4 套主题。支持内容主题扩展接口。\n\n* 需在显示元素上添加 `class=\"vditor-reset\"`\n* 编辑器初始化时可通过 `options.preview.theme` 设置内置或自己开发的主题列表\n* 内容渲染初始化时可通过 `IPreviewOptions.theme` 设置内置或自己开发的主题\n* 初始化完成后可通过 `setTheme` 或 `setContentTheme` 更新内容主题\n\n#### 代码主题\n\n代码块所展现的外观。内置 github 等 36 套主题。\n\n* 编辑器初始化时可通过 `options.preview.hljs` 对代码块样式、行号、是否启用进行设置\n* 内容渲染初始化时可通过 `IPreviewOptions.hljs` 对代码块样式、行号、是否启用进行设置\n* 初始化完成后可通过 `setTheme` 或 `setCodeTheme` 更新代码主题\n\n### API\n\n#### id\n\n可填入元素 `id` 或元素自身 `HTMLElement`\n\n⚠️：当填入元素自身的 `HTMLElement` 时需设置 `options.cache.id` 或将 `options.cache.enable` 设置为 `false`\n\n#### options\n\n|   | 说明 | 默认值 |\n| - | - | - |\n| i18n | 多语言，参见 ITips | - |\n| undoDelay | 历史记录间隔 | - |\n| after | 编辑器异步渲染完成后的回调方法 | - |\n| height | 编辑器总高度 | 'auto' |\n| minHeight | 编辑区域最小高度 | - |\n| width | 编辑器总宽度，支持 % | 'auto' |\n| placeholder | 输入区域为空时的提示 | '' |\n| lang | 语言种类：en_US, fr_FR, pt_BR, ja_JP, ko_KR, ru_RU, sv_SE, zh_CN, zh_TW | 'zh_CN' |\n| input(value: string) | 输入后触发  | - |\n| focus(value: string) | 聚焦后触发 | - |\n| blur(value: string) | 失焦后触发 | - |\n| keydown(event: KeyboardEvent) | 按下后触发 | - |\n| esc(value: string) | \u003ckbd\u003eesc\u003c/kbd\u003e 按下后触发 | - |\n| ctrlEnter(value: string) | \u003ckbd\u003e⌘/ctrl+enter\u003c/kbd\u003e 按下后触发 | - |\n| select(value: string) | 编辑器中选中文字后触发 | - |\n| unSelect() | 编辑器中未选中文字后触发 | - |\n| tab | \u003ckbd\u003etab\u003c/kbd\u003e 键操作字符串，支持 `\\t` 及任意字符串 | - |\n| typewriterMode | 是否启用打字机模式 | false |\n| cdn | 配置自建 CDN 地址 | `https://unpkg.com/vditor@${VDITOR_VERSION}` |\n| mode | 可选模式：sv, ir, wysiwyg | 'ir' |\n| debugger | 是否显示日志 | false |\n| value | 编辑器初始化值 | '' |\n| theme | 主题：classic, dark | 'classic' |\n| icon | 图标风格：ant, material | 'ant' |\n| customRenders: {language: string, render: (element: HTMLElement, vditor: IVditor) =\u003e void}[] | 自定义渲染器 | [] |\n\n#### options.toolbar\n\n* 工具栏，可使用 name 进行简写： `toolbar: ['emoji', 'br', 'bold', '|', 'line']` 。默认值参见 [src/ts/util/Options.ts](https://github.com/Vanessa219/vditor/blob/master/src/ts/util/Options.ts)\n* name 可枚举为： `emoji`，`headings`，`bold`，`italic`，`strike`，`|`，`line`，`quote`，`list`，`ordered-list`，`check` ,`outdent` ,`indent`，`code`，`inline-code`，`insert-after`，`insert-before` ,`undo`，`redo`，`upload`，`link`，`table`，`record`，`edit-mode`，`both`，`preview`，`fullscreen`，`outline`，`code-theme`，`content-theme`，`export`, `devtools`，`info`，`help`，`br`\n* 当 `name` 不在枚举中时，可以添加自定义按钮，格式如下：\n\n```js\nnew Vditor('vditor', {\n  toolbar: [\n    {\n      hotkey: '⇧⌘S',\n      name: 'sponsor',\n      tipPosition: 's',\n      tip: '成为赞助者',\n      className: 'right',\n      icon: '\u003csvg 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\"\u003e\u003cpath 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\"\u003e\u003c/path\u003e\u003cpath 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\"\u003e\u003c/path\u003e\u003cpath 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\"\u003e\u003c/path\u003e\u003cpath 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\"\u003e\u003c/path\u003e\u003cpath 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\"\u003e\u003c/path\u003e\u003cpath 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\"\u003e\u003c/path\u003e\u003cpath 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\"\u003e\u003c/path\u003e\u003cpath 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\"\u003e\u003c/path\u003e\u003cpath 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\"\u003e\u003c/path\u003e\u003cpath 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\"\u003e\u003c/path\u003e\u003c/svg\u003e',\n      click () {alert('捐赠地址：https://ld246.com/sponsor')},\n    }],\n})\n```\n\n|   | 说明 | 默认值 |\n| - | - | - |\n| name | 唯一标示 | - |\n| icon | svg 图标 | - |\n| tip | 提示 | - |\n| tipPosition | 提示位置：'n', 'ne', 'nw', 's', 'se', 'sw', 'w', 'e' | - |\n| hotkey | 快捷键，格式为\u003ckbd\u003e⇧⌘\u003c/kbd\u003e/\u003ckbd\u003e⌘\u003c/kbd\u003e/\u003ckbd\u003e⌥⌘\u003c/kbd\u003e| - |\n| suffix | 插入编辑器中的后缀 | - |\n| prefix | 插入编辑器中的前缀 | - |\n| click(event: Event, vditor: IVditor) | 自定义按钮点击时触发的事件 | - |\n| className | 样式名 | '' |\n| toolbar?: Array\u003coptions.toolbar\u003e | 子菜单 | - |\n\n#### options.toolbarConfig\n\n|   | 说明 | 默认值 |\n| - | - | - |\n| hide | 是否隐藏工具栏 | false |\n| pin | 是否固定工具栏 | false |\n\n#### options.counter\n\n|   | 说明 | 默认值 |\n| - | - | - |\n| enable | 是否启用计数器 | false |\n| after(length: number, counter: options.counter): void | 字数统计回调 | - |\n| max | 允许输入的最大值 | - |\n| type | 统计类型：'markdown', 'text' | 'markdown' |\n\n#### options.cache\n\n|   | 说明 | 默认值 |\n| - | - | - |\n| enable | 是否使用 localStorage 进行缓存 | true |\n| id | 缓存 key，第一个参数为元素且启用缓存时**必填** | - |\n| after(html: string): string | 缓存后的回调 | - |\n\n#### options.comment\n\n⚠️：仅支持 wysiwyg 模式\n\n|   | 说明 | 默认值 |\n| - | - | - |\n| enable | 是否启用评论模式 | false |\n| add(id: string, text: string, commentsData: ICommentsData[]) | 添加评论回调 | - |\n| remove(ids: string[]) | 删除评论回调 | - |\n| scroll(top: number) | 滚动回调 | - |\n| adjustTop(commentsData: ICommentsData[]) | 文档修改时，适配评论高度 | - |\n\n#### options.preview\n\n|   | 说明 | 默认值 |\n| - | - | - |\n| delay | 预览 debounce 毫秒间隔 | 1000 |\n| maxWidth | 预览区域最大宽度 | 800 |\n| mode | 显示模式：both, editor | 'both' |\n| url | md 解析请求 | - |\n| parse(element: HTMLElement) | 预览回调 | - |\n| transform(html: string): string | 渲染之前回调 | - |\n\n#### options.preview.hljs\n\n|   | 说明 | 默认值 |\n| - | - | - |\n| defaultLang | 未指定语言时默认使用该语言 | '' |\n| enable | 是否启用代码高亮 | true |\n| style | 可选值参见[Chroma](https://xyproto.github.io/splash/docs/longer/all.html) | `github` |\n| lineNumber | 是否启用行号 | false |\n| langs | 自定义指定语言 | [CODE_LANGUAGES](https://github.com/Vanessa219/vditor/blob/53ca8f9a0e511b37b5dae7c6b15eb933e9e02ccd/src/ts/constants.ts#L20) |\n| renderMenu(code: HTMLElement, copy: HTMLElement) | 渲染菜单按钮 | - |\n\n#### options.preview.markdown\n\n|   | 说明 | 默认值 |\n| - | - | - |\n| autoSpace | 自动空格 | false |\n| gfmAutoLink | 自动链接 | true |\n| fixTermTypo | 自动矫正术语 | false |\n| toc | 插入目录 | false |\n| footnotes | 脚注 | true |\n| codeBlockPreview | wysiwyg 和 ir 模式下是否对代码块进行渲染 | true |\n| mathBlockPreview | wysiwyg 和 ir 模式下是否对数学公式进行渲染 | true |\n| paragraphBeginningSpace | 段落开头空两个 | false |\n| sanitize | 是否启用过滤 XSS | true |\n| listStyle | 为列表添加 data-style 属性 | false |\n| linkBase | 链接相对路径前缀 | '' |\n| linkPrefix | 链接强制前缀 | '' |\n| mark | 启用 mark 标记 | false |\n\n#### options.preview.theme\n\n|   | 说明 | 默认值 |\n| - | - | - |\n| current | 当前主题 | \"light\" |\n| list | 可选主题列表 | { \"ant-design\": \"Ant Design\", dark: \"Dark\", light: \"Light\", wechat: \"WeChat\" } |\n| path | 主题样式地址 | `https://unpkg.com/vditor@${VDITOR_VERSION}/dist/css/content-theme` |\n\n#### options.preview.math\n\n|   | 说明 | 默认值 |\n| - | - | - |\n| inlineDigit | 内联数学公式起始 $ 后是否允许数字 | false |\n| macros | 使用 MathJax 渲染时传入的宏定义 | {} |\n| engine | 数学公式渲染引擎：KaTeX, MathJax | 'KaTeX' |\n| mathJaxOptions | 数学公式渲染引擎为 MathJax 时的参数 | - |\n\n#### options.preview.actions?: Array\u003cIPreviewAction | IPreviewActionCustom\u003e\n\n默认值为 [\"desktop\", \"tablet\", \"mobile\", \"mp-wechat\", \"zhihu\"]。\n可从默认值中挑选进行配置，也可使用以下字段进行自定制开发。\n\n|   | 说明 | 默认值 |\n| - | - | - |\n| key | 按钮唯一标识，不能为空 | - |\n| text | 按钮文字 | - |\n| tooltip | 提示 | - |\n| className | 按钮类名 | - |\n| click(key: string) | 按钮点击回调事件 | - |\n\n#### options.preview.render.media\n\n|        | 说明        | 默认值  |\n|--------|-----------|------|\n| enable | 是否启用多媒体渲染 | true |\n\n#### options.image\n\n|   | 说明 | 默认值 |\n| - | - | - |\n| isPreview | 是否预览图片 | true |\n| preview(bom: Element) =\u003e void | 图片预览处理 | - |\n\n#### options.link\n\n|   | 说明 | 默认值 |\n| - | - | - |\n| isOpen | 是否打开链接地址 | true |\n| click(bom: Element) =\u003e void | 点击链接事件 | - |\n\n#### options.hint\n\n|   | 说明 | 默认值 |\n| - | - | - |\n| parse | 是否进行 md 解析 | true |\n| delay | 提示 debounce 毫秒间隔 | 200 |\n| emoji | 默认表情，可从[lute/emoji_map](https://github.com/88250/lute/blob/master/parse/emoji_map.go) 中选取，也可自定义 | { '+1': '👍', '-1': '👎', 'heart': '❤️', 'cold_sweat': '😰' } |\n| emojiTail | 常用表情提示 | - |\n| emojiPath | 表情图片地址 | `https://unpkg.com/vditor@${VDITOR_VERSION}/dist/images/emoji` |\n| extend: IHintExtend[] | 对 @/话题等关键字自动补全的扩展 | [] |\n\n```ts\ninterface IHintData {\n  html: string;\n  value: string;\n}\n\ninterface IHintExtend {\n    key: string;\n\n    hint?(value: string): IHintData[] | Promise\u003cIHintData[]\u003e;\n}\n```\n\n#### options.upload\n\n* 文件上传的数据结构如下。后端返回的数据结构不一致时，可使用 `format` 进行转换。\n\n```js\n// POST data\nxhr.send(formData);  // formData = FormData.append(\"file[]\", File)\n// return data\n{\n \"msg\": \"\",\n \"code\": 0,\n \"data\": {\n \"errFiles\": ['filename', 'filename2'],\n \"succMap\": {\n   \"filename3\": \"filepath3\",\n   \"filename3\": \"filepath3\"\n   }\n }\n}\n```\n\n* 为了防止站外图片失效，`linkToImgUrl` 可将剪贴板中的站外图片地址传到服务器端进行保存处理，其数据结构如下：\n\n```js\n// POST data\nxhr.send(JSON.stringify({url: src})); // src 为站外图片地址\n// return data\n{\n msg: '',\n code: 0,\n data : {\n   originalURL: '',\n   url: ''\n }\n}\n```\n\n* `success`，`format`，`error` 不会同时触发，具体调用情况如下：\n\n```js\nif (xhr.status === 200) {\n    if (vditor.options.upload.success) {\n        vditor.options.upload.success(editorElement, xhr.responseText);\n    } else {\n        let responseText = xhr.responseText;\n        if (vditor.options.upload.format) {\n            responseText = vditor.options.upload.format(files as File [], xhr.responseText);\n        }\n        genUploadedLabel(responseText, vditor);\n    }\n} else {\n    if (vditor.options.upload.error) {\n        vditor.options.upload.error(xhr.responseText);\n    } else {\n        vditor.tip.show(xhr.responseText);\n    }\n}\n```\n\n|   | 说明 | 默认值 |\n| - | - | - |\n| url | 上传 url，为空则不会触发上传相关事件 | '' |\n| max | 上传文件最大 Byte | 10 * 1024 * 1024 |\n| linkToImgUrl | 剪切板中包含图片地址时，使用此 url 重新上传 | '' |\n| linkToImgCallback(responseText: string) | 图片地址上传回调 | - |\n| linkToImgFormat(responseText: string): string | 对图片地址上传的返回值进行格式化 | - |\n| success(editor: HTMLPreElement, msg: string) | 上传成功回调 | - |\n| error(msg: string) | 上传失败回调 | - |\n| token | CORS 上传验证，头为 X-Upload-Token | - |\n| withCredentials | 跨站点访问控制 | false |\n| headers | 请求头设置 | - |\n| filename(name: string): string | 文件名安全处理 | name =\u003e name.replace(/\\W/g, '') |\n| accept | 文件上传类型，同[input accept](https://www.w3schools.com/tags/att_input_accept.asp) | - |\n| validate(files: File[]) =\u003e string \\| boolean | 校验，成功时返回 true 否则返回错误信息 | - |\n| handler(files: File[]) =\u003e string \\| null \\| Promise\u003cstring\u003e \\| Promise\u003cnull\u003e | 自定义上传，当发生错误时返回错误信息 | - |\n| format(files: File[], responseText: string): string | 对服务端返回的数据进行转换，以满足内置的数据结构 | - |\n| file(files: File[]): File[] \\| Promise\u003cFile[]\u003e | 将上传的文件处理后再返回 | - |\n| cancel(files: File[]): void | 取消正在上传的文件 | - |\n| setHeaders(): { [key: string]: string } | 上传前使用返回值设置头 | - |\n| extraData: { [key: string]: string \\| Blob } | 为 FormData 添加额外的参数 | - |\n| multiple | 上传文件是否为多个 | true |\n| fieldName | 上传字段名称 | 'file[]' |\n| renderLinkDest?(vditor: IVditor, node: ILuteNode, entering: boolean): [string, number] | 处理剪贴板中的图片地址 | '' |\n\n#### options.resize\n\n|   | 说明 | 默认值 |\n| - | - | - |\n| enable | 是否支持大小拖拽 | false |\n| position | 拖拽栏位置：'top', 'bottom' | 'bottom' |\n| after(height: number) | 拖拽结束的回调 | - |\n\n#### options.classes\n\n|   | 说明 | 默认值 |\n| - | - | - |\n| preview | 预览元素上的 className | '' |\n\n#### options.fullscreen\n\n|   | 说明 | 默认值 |\n| - | - | - |\n| index | 全屏层级 | 90 |\n\n#### options.outline\n\n|   | 说明 | 默认值 |\n| - | - | - |\n| enable | 初始化是否展现大纲 | false |\n| position | 大纲位置：'left', 'right' | 'left' |\n\n#### methods\n\n|   | 说明 |\n| - | - |\n| exportJSON(markdown: string) | 根据 Markdown 获取对应 JSON |\n| getValue() | 获取 Markdown 内容 |\n| getHTML() | 获取 HTML 内容 |\n| insertValue(value: string, render = true) | 在焦点处插入内容，并默认进行 Markdown 渲染 |\n| focus() | 聚焦到编辑器 |\n| blur() | 让编辑器失焦 |\n| disabled() | 禁用编辑器 |\n| enable() | 解除编辑器禁用 |\n| getSelection(): string | 返回选中的字符串 |\n| setValue(markdown: string, clearStack = false) | 设置编辑器内容且选中清空历史栈 |\n| clearStack() | 清空撤销和重做记录栈|\n| renderPreview(value?: string) | 设置预览区域内容 |\n| getCursorPosition():{top: number, left: number} | 获取焦点位置 |\n| deleteValue() | 删除选中内容 |\n| updateValue(value: string) | 更新选中内容 |\n| isUploading() | 上传是否还在进行中 |\n| clearCache() | 清除缓存 |\n| disabledCache() | 禁用缓存 |\n| enableCache() | 启用缓存 |\n| html2md(value: string) | HTML 转 md |\n| tip(text: string, time: number) | 消息提示。time 为 0 将一直显示 |\n| setPreviewMode(mode: \"both\" \\| \"editor\") | 设置预览模式 |\n| setTheme(theme: \"dark\" \\| \"classic\", contentTheme?: string, codeTheme?: string, contentThemePath?: string) | 设置主题、内容主题及代码块风格 |\n| getCurrentMode(): string | 获取编辑器当前编辑模式 |\n| destroy() | 销毁编辑器 |\n| getCommentIds(): {id: string, top: number}[] | 获取所有评论 |\n| hlCommentIds(ids: string[]) | 高亮评论 |\n| unHlCommentIds(ids: string[]) | 取消评论高亮 |\n| removeCommentIds(removeIds: string[]) | 删除评论 |\n| updateToolbarConfig(config: {hide?: boolean, pin?: boolean}) | 更新工具栏配置 |\n| insertEmptyBlock(position: InsertPosition) | 插入空快 |\n\n#### static methods\n\n* 不需要进行编辑操作时，仅需引入 [`method.min.js`](https://unpkg.com/vditor/dist/) 后如下直接调用\n\n```js\nVditor.mermaidRender(document)\n```\n\n```js\nimport VditorPreview from 'vditor/dist/method.min'\nVditorPreview.mermaidRender(document)\n```\n\n* 需要对页面中的 Markdown 进行渲染时可直接调用 `preview` 方法，参数如下：\n\n```ts\npreviewElement: HTMLDivElement,   // 使用该元素进行渲染\nmarkdown: string,  // 需要渲染的 markdown 原文\noptions?: IPreviewOptions {\n  mode: \"dark\" | \"light\";\n  anchor?: number;  // 为标题添加锚点 0：不渲染；1：渲染于标题前；2：渲染于标题后，默认 0\n  customEmoji?: { [key: string]: string };    // 自定义 emoji，默认为 {}\n  lang?: (keyof II18nLang);    // 语言，默认为 'zh_CN'\n  emojiPath?: string;    // 表情图片路径\n  hljs?: IHljs; // 参见 options.preview.hljs\n  speech?: {  // 对选中后的内容进行阅读\n    enable?: boolean,\n  };\n  math?: IMath; // 数学公式渲染配置\n  cdn?: string; // 自建 CDN 地址\n  transform?(html: string): string; // 在渲染前进行的回调方法\n  after?(); // 渲染完成后的回调\n  lazyLoadImage?: string; // 设置为 Loading 图片地址后将启用图片的懒加载\n  markdown?: options.preview.markdown;\n  theme?: options.preview.theme;\n  render?: options.preview.render;\n  renderers?: ILuteRender; // 自定义渲染 https://ld246.com/article/1588412297062\n}\n```\n\n* ⚠️ `method.min.js`  和 `index.min.js` 不可同时引入\n\n|   | 说明 |\n| - | - |\n| previewImage(oldImgElement: HTMLImageElement, lang: keyof II18n = \"zh_CN\", theme = \"classic\") | 点击图片预览 |\n| mermaidRender(element: HTMLElement, cdn = options.cdn, theme = options.theme) | 流程图/时序图/甘特图 |\n| SMILESRender(element: HTMLElement, cdn = options.cdn, theme = options.theme) | 化学物质结构 |\n| markmapRender(element: HTMLElement, cdn = options.cdn) | markdown 思维导图 |\n| flowchartRender(element: HTMLElement, cdn = options.cdn) | flowchart 渲染 |\n| codeRender(element: HTMLElement, option?: IHljs) | 为 element 中的代码块添加复制按钮 |\n| chartRender(element: (HTMLElement \\| Document) = document, cdn = options.cdn, theme = options.theme) | 图表渲染 |\n| mindmapRender(element: (HTMLElement \\| Document) = document, cdn = options.cdn, theme = options.theme) | 脑图渲染 |\n| plantumlRender(element: (HTMLElement \\| Document) = document, cdn = options.cdn) | plantuml 渲染 |\n| abcRender(element: (HTMLElement \\| Document) = document, cdn = options.cdn) | 五线谱渲染 |\n| md2html(mdText: string, options?: IPreviewOptions): Promise\\\u003cstring\u003e | Markdown 文本转换为 HTML，该方法需使用[异步编程](https://ld246.com/article/1546828434083?r=Vanessa#toc_h3_1) |\n| preview(previewElement: HTMLDivElement, markdown: string, options?: IPreviewOptions) | 页面 Markdown 文章渲染 |\n| highlightRender(hljsOption?: IHljs, element?: HTMLElement \\| Document, cdn = options.cdn) | 为 element 中的代码块进行高亮渲染 |\n| mediaRender(element: HTMLElement) | 为[特定链接](https://ld246.com/article/1589813914768)分别渲染为视频、音频、嵌入的 iframe |\n| mathRender(element: HTMLElement, options?: {cdn?: string, math?: IMath}) | 对数学公式进行渲染 |\n| speechRender(element: HTMLElement, lang?: (keyof II18nLang)) | 对选中的文字进行阅读 |\n| graphvizRender(element: HTMLElement, cdn?: string) | 对 graphviz 进行渲染 |\n| outlineRender(contentElement: HTMLElement, targetElement: Element) | 对大纲进行渲染 |\n| lazyLoadImageRender(element: (HTMLElement \\| Document) = document) | 对启用懒加载的图片进行渲染 |\n| setCodeTheme(codeTheme: string, cdn = options.cdn) | 设置代码主题，codeTheme 参见 options.preview.hljs.style |\n| setContentTheme(contentTheme: string, path: string) | 设置内容主题，contentTheme 参见 options.preview.theme.list |\n\n## 🏗 开发文档\n\n### 原理相关\n\n* [关于所见即所得 Markdown 编辑器的讨论](https://ld246.com/article/1579414663700)\n* [Vditor 实现 Markdown 所见即所得](https://ld246.com/article/1577370404903)\n* [Lute 一款对中文语境优化的 Markdown 引擎，支持 Go 和 JavaScript](https://ld246.com/article/1567047822949)\n\n### 环境\n\n1. 安装 [node](https://nodejs.org/) LTS 版本\n2. [下载](https://github.com/Vanessa219/vditor/archive/master.zip)最新代码并解压\n3. 根目录运行 `npm install`\n4. `npm run start` 启动本地服务器，打开 http://localhost:9000\n5. 修改代码\n6. `npm run build` 打包代码到 dist 目录\n\n### CDN 切换\n\n由于使用了按需加载的机制，默认 CDN 为 [https://unpkg.com/vditor](https://unpkg.com/vditor)@版本号\n\n如果代码有修改或需要使用自建 CDN 的话，可按以下步骤进行操作：\n\n* 初始化时，需对 `options` 及 `IPreviewOptions` 中的 `cdn`，`emojiPath`, `themes` 进行配置\n* `highlightRender`，`mathRender`，`abcRender`，`chartRender`，`mermaidRender`，`SMILESRender`，`markmapRender`，`flowchartRender`，`mindmapRender`，`plantumlRender`，`graphvizRender`，`setCodeTheme`，`setContentTheme` 方法中需添加 cdn 参数\n* 将 build 成功的 dist 目录或 [jsDelivr](https://www.jsdelivr.com/package/npm/vditor?path=dist) 中的 dist 目录拷贝至正确的位置\n\n### 升级\n\n版本升级时请**仔细阅读** [CHANGELOG](https://github.com/Vanessa219/vditor/blob/master/CHANGELOG.md) 中的**升级**部分\n\n## Ⓜ️ Markdown 使用指南\n\n* [基础语法](https://ld246.com/article/1583129520165)\n* [扩展语法](https://ld246.com/article/1583305480675)\n* [速查手册](https://ld246.com/article/1583308420519)\n\n## 🏘️ 社区\n\n* [官网](https://b3log.org/vditor)\n* [讨论区](https://ld246.com/tag/vditor)\n* [报告问题](https://github.com/Vanessa219/vditor/issues/new)\n\n## 📄 授权\n\nVditor 使用 [MIT](https://opensource.org/licenses/MIT) 开源协议。\n\n## 🙏 鸣谢\n\n* [Lute](https://github.com/88250/lute)：🎼 一款结构化的 Markdown 引擎，支持 Go 和 JavaScript\n* [highlight.js](https://github.com/highlightjs/highlight.js)：JavaScript syntax highlighter\n* [mermaid](https://github.com/knsv/mermaid)：Generation of diagram and flowchart from text in a similar manner as Markdown\n* [incubator-echarts](https://github.com/apache/incubator-echarts)：A powerful, interactive charting and visualization library for browser\n* [abcjs](https://github.com/paulrosen/abcjs)：JavaScript library for rendering standard music notation in a browser\n\n## 📽️ 历史\n\n我们在开发 [Sym](https://github.com/88250/symphony) 的初期是直接使用 WYSIWYG 富文本编辑器的。那时候基于 HTML 的编辑器非常流行，项目中引用起来也很方便，也符合用户当时的使用习惯。\n\n后来，Markdown 的崛起逐步改变了大家的排版方式。再加上我们其他几个项目都是面向程序员用户的，所以迁移到 md 上也是大势所趋。我们选择了 [CodeMirror](https://github.com/codemirror/CodeMirror)，这是一款优秀的编辑器，它对开发者提供了丰富的编程接口，对各种浏览器的兼容性也比较好。\n\n再后来，随着我们项目业务需求方面的沉淀，使用 CodeMirror 有时候会感到比较“笨重”。比如要实现 @自动完成用户名列表、插入 Emoji、上传文件等就需要比较深入的二次开发，而这些业务需求恰恰是很多项目场景共有且必备的。\n\n终于，我们决定开始在 Sym 中自己实现编辑器。随着几个版本的迭代，Sym 的编辑器也日趋成熟。在我们运营的社区[链滴](https://ld246.com)上陆续有人问我们是否能将编辑器单独抽离出来提供给大家使用。与此同时，我们的前端主程 [V](https://ld246.com/member/Vanessa) 同学对于维护分散在各个项目中的编辑器也感到有点力不从心，外加对 TypeScript 的好感，所以就决定使用 ts 来实现一个全新的浏览器端 md 编辑器。\n\n于是，Vditor 就这样诞生了。\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvanessa219%2Fvditor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvanessa219%2Fvditor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvanessa219%2Fvditor/lists"}