Skip to content

Commit

Permalink
📝 #1158
Browse files Browse the repository at this point in the history
  • Loading branch information
Vanessa219 committed Sep 25, 2024
1 parent 5ed8c28 commit ad6963f
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 6 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

### 升级
* 3.9
* 添加 markmapRender 方法
* 添加 SMILESRender 方法
* 添加 insertMD 方法
* 添加 options.upload.renderLinkDest
* 添加 options.preview.math.mathJaxOptions
Expand All @@ -19,6 +21,7 @@

### v3.10.7 / 2024-10

* [支持化学物质结构渲染](https://github.com/Vanessa219/vditor/issues/1158) `引入特性`
* [内容为空时使用工具栏插入表情错误](https://github.com/Vanessa219/vditor/issues/1662) `修复缺陷`
* [更新 hljs,支持更多的语言和外观](https://github.com/Vanessa219/vditor/issues/1680) `改进功能`
* [撤销后 echart 无法渲染](https://github.com/Vanessa219/vditor/issues/1673) `修复缺陷`
Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ Vditor 在这些方面做了努力,希望能为现代化的通用 Markdown 编

* [Sym](https://github.com/88250/symphony) 一款用 Java 实现的现代化社区(论坛/BBS/社交网络/博客)平台
* [Solo](https://github.com/88250/solo) & [Pipe](https://github.com/88250/pipe) B3log 分布式社区的博客端节点,欢迎加入下一代社区网络
* [Tditor](https://tditor.com) 基于React、Vditor、Springboot, 一款打造极致文字创作体验的在线Markdown编辑平台
* [Tditor](https://tditor.com) 基于React、Vditor、Springboot,一款打造极致文字创作体验的在线Markdown编辑平台
* [Arya](https://github.com/nicejade/markdown-online-editor) 基于 Vue、Vditor,所构建的在线 Markdown 编辑器
* [更多案例](https://github.com/Vanessa219/vditor/network/dependents?package_id=UGFja2FnZS0zMTY2Mzg4MzE%3D)

Expand Down Expand Up @@ -222,7 +222,7 @@ Markdown 输出的 HTML 所展现的外观。内置 ant-design, light,dark,w
#### options.toolbar

* 工具栏,可使用 name 进行简写: `toolbar: ['emoji', 'br', 'bold', '|', 'line']` 。默认值参见 [src/ts/util/Options.ts](https://github.com/Vanessa219/vditor/blob/master/src/ts/util/Options.ts)
* 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`
* 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`
*`name` 不在枚举中时,可以添加自定义按钮,格式如下:

```js
Expand Down Expand Up @@ -424,7 +424,7 @@ xhr.send(formData); // formData = FormData.append("file[]", File)
}
```

* 为了防止站外图片失效, `linkToImgUrl` 可将剪贴板中的站外图片地址传到服务器端进行保存处理,其数据结构如下:
* 为了防止站外图片失效,`linkToImgUrl` 可将剪贴板中的站外图片地址传到服务器端进行保存处理,其数据结构如下:

```js
// POST data
Expand Down Expand Up @@ -594,6 +594,8 @@ options?: IPreviewOptions {
| - | - |
| previewImage(oldImgElement: HTMLImageElement, lang: keyof II18n = "zh_CN", theme = "classic") | 点击图片预览 |
| mermaidRender(element: HTMLElement, cdn = options.cdn, theme = options.theme) | 流程图/时序图/甘特图 |
| SMILESRender(element: HTMLElement, cdn = options.cdn, theme = options.theme) | 化学物质结构 |
| markmapRender(element: HTMLElement, cdn = options.cdn) | markdown 思维导图 |
| flowchartRender(element: HTMLElement, cdn = options.cdn) | flowchart 渲染 |
| codeRender(element: HTMLElement, option?: IHljs) | 为 element 中的代码块添加复制按钮 |
| chartRender(element: (HTMLElement \| Document) = document, cdn = options.cdn, theme = options.theme) | 图表渲染 |
Expand Down Expand Up @@ -636,7 +638,7 @@ options?: IPreviewOptions {
如果代码有修改或需要使用自建 CDN 的话,可按以下步骤进行操作:
* 初始化时,需对 `options``IPreviewOptions` 中的 `cdn``emojiPath`, `themes` 进行配置
* `highlightRender` , `mathRender` , `abcRender` , `chartRender` , `mermaidRender` `flowchartRender``mindmapRender``graphvizRender``setCodeTheme``setContentTheme` 方法中需添加 cdn 参数
* `highlightRender``mathRender``abcRender``chartRender``mermaidRender``SMILESRender``markmapRender``flowchartRender``mindmapRender``plantumlRender``graphvizRender``setCodeTheme``setContentTheme` 方法中需添加 cdn 参数
* 将 build 成功的 dist 目录或 [jsDelivr](https://www.jsdelivr.com/package/npm/vditor?path=dist) 中的 dist 目录拷贝至正确的位置
### 升级
Expand Down
4 changes: 3 additions & 1 deletion README_en_US.md
Original file line number Diff line number Diff line change
Expand Up @@ -546,6 +546,8 @@ options?: IPreviewOptions {
| - | - |
| previewImage(oldImgElement: HTMLImageElement, lang: keyof II18n = "zh_CN", theme = "classic") | Click on the image to preview |
| mermaidRender(element: HTMLElement, cdn = options.cdn, theme = options.theme) | flowchart/sequence diagram/gantt diagram rendering |
| SMILESRender(element: HTMLElement, cdn = options.cdn, theme = options.theme) | the structure of chemical |
| markmapRender(element: HTMLElement, cdn = options.cdn) | markdown Mind Map |
| flowchartRender(element: HTMLElement, cdn = options.cdn) | flowchart.js rendering |
| codeRender(element: HTMLElement, option?: IHljs) | Add a copy button for the code block in element |
| chartRender(element: (HTMLElement\| Document) = document, cdn = options.cdn, theme = options.theme) | Chart rendering |
Expand Down Expand Up @@ -588,7 +590,7 @@ Due to the on-demand loading mechanism, the default CDN is [https://unpkg.com/vd
If the code is modified or you need to use a self-built CDN, you can follow the steps below:
* The initial `options` and` IPreviewOptions` need to add `cdn` configuration
* `highlightRender`,` mathRender`, `abcRender`,` chartRender`, `mermaidRender` methods need to add cdn parameter
* `highlightRender`, `mathRender`, `abcRender`, `chartRender`, `mermaidRender`, `SMILESRender`, `markmapRender`, `flowchartRender`, `mindmapRender`, `plantumlRender`, `graphvizRender`, `setCodeTheme`, `setContentTheme` methods need to add cdn parameter
* Copy the dist directory in the successful build or [jsDelivr](https://www.jsdelivr.com/package/npm/vditor?path=dist) to the correct location
### Upgrade
Expand Down
2 changes: 1 addition & 1 deletion src/method.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ class Vditor {
public static mermaidRender = mermaidRender;
/** 化学物质结构渲染 */
public static SMILESRender = SMILESRender;
/** 支持markdown的思维导图 */
/** 支持 markdown 的思维导图 */
public static markmapRender = markmapRender;
/** flowchart.js 渲染 */
public static flowchartRender = flowchartRender;
Expand Down

0 comments on commit ad6963f

Please sign in to comment.