图像

Markdown Preview Enhanced 内部支持 flow charts, sequence diagrams, mermaid, PlantUML, WaveDrom, GraphVizVega & Vega-liteDitaa 图像渲染。
你也可以通过使用 Code Chunk 来渲染 TikZ, Python Matplotlib, Plotly 等图像。

Please note that some diagrams doesn’t work well with file export like PDF, pandoc, etc.

Flow Charts

这一特性基于 flowchart.js

screenshot from 2017-11-25 21-43-02

Sequence Diagrams

这一特性基于 js-sequence-diagrams

  • sequence 代码快中的内容将会被 js-sequence-diagrams 渲染。
  • 支持两个主题 simple(默认主题)和 hand

screenshot from 2017-11-25 21-47-41

Mermaid

Markdown Preview Enhanced 使用 mermaid 来渲染流程图和时序图。

  • mermaid 代码块中的内容将会渲染 mermaid 图像。
  • 查看 mermaid 文档 了解更多如果创建图形。
    screen shot 2017-06-05 at 8 04 58 pm

三个 mermaid 主题是支持的,并且你可以在 插件设置 中设置主题:

  • mermaid.css
  • mermaid.dark.css
  • mermaid.forest.css
    screen shot 2017-06-05 at 8 47 00 pm

你还可以通过 Markdown Preview Enhanced: Open Mermaid Config 命令打开 mermaid 配置文件。

PlantUML

Markdown Preview Enhanced 使用 PlantUML 来创建各种图形。(Java 是需要先被安装好的)

  • 你可以安装 Graphviz(非必需)来辅助生成各种各种图形。
  • puml 或者 plantuml 代码块中的内容将会被 PlantUML 渲染。

screen shot 2017-06-05 at 8 05 55 pm

如果代码中 @start... 没有被找到,那么 @startuml ... @enduml 将会被自动添加。

WaveDrom

Markdown Preview Enhanced 使用 WaveDrom 来渲染 digital timing diagram.

  • wavedrom 代码块中的内容将会被 WaveDrom 渲染。

screen shot 2017-06-05 at 8 07 30 pm

GraphViz

Markdown Preview Enhanced 使用 Viz.js 来渲染 dot 语言 图形。

  • viz 或者 dot 代码块中的内容将会被 Viz.js 渲染。
  • 你可以通过 {engine="..."} 来选择不同的渲染引擎。 引擎 circodotneatoosage,或者 twopi 是被支持的。默认下,使用 dot 引擎。

screen shot 2017-07-14 at 1 12 30 am

Vega 和 Vega-lite

Markdown Preview Enhanced 支持 vega 以及 vega-lite静态图像.

  • vega 代码块中的内容将会被 vega 渲染。
  • vega-lite 代码块中的内容将会被 vega-lite 渲染。
  • JSON 以及 YAML 的输入是支持的。

screen shot 2017-07-28 at 7 59 58 am

你也可以 @import 一个 JSON 或者 YAML 文件作为 vega 图像,例如:

  1. @import "your_vega_source.json" {as="vega"}
  2. @import "your_vega_lite_source.json" {as="vega-lite"}

Ditaa

Markdown Preview Enhanced 支持 ditaa

(Java 是需要先被安装好的)

ditaa 整合于 code chunk, for example:

  1. ```ditaa {cmd=true args=["-E"]}
  2. +--------+ +-------+ +-------+
  3. | | --+ ditaa +--> | |
  4. | Text | +-------+ |diagram|
  5. |Document| |!magic!| | |
  6. | {d}| | | | |
  7. +---+----+ +-------+ +-------+
  8. : ^
  9. | Lots of work |
  10. +-------------------------+
  11. ```

shift-enter 来运行 code chunk。
设置 {hide=true} 来隐藏代码块。
设置 {run_on_save=true} 启动当文件保存时,渲染 ditaa 图像。

screen shot 2017-07-28 at 8 11 15 am


如果你只是想要显示代码块而不想画图,则只要在后面添加 {code_block=true} 即可:

  1. ```mermaid {code_block=true}
  2. // 你的 mermaid 代码
  3. ```

你可以为图像的容器添加属性。
例如:

  1. ```puml {align="center"}
  2. a->b
  3. ```

将会把 puml 的图像放在中间。


当你保存你的 markdown 文件到 GFM Markdown 时, 所有图像将会被保存为 png 文件到 imageFolderPath 文件夹。
你可以设置导出文件的文件名 {filename="图片.png"}

例如:

  1. ```mermaid {filename="我的mermaid.png"}
  2. ...
  3. ```

➔ TOC