GitHub的markdown支持mermaid来渲染图表

GitHub的markdown支持mermaid.js,直接把你在md里的mermaid代码利用iframe渲染为可交互的各种类型的图表(譬如流程图等等)。相关支持可以看看GitHub官方博客:Include diagrams in your Markdown files with Mermaid – The GitHub Blog

Mermaid.js的功能挺多的,可以访问 Tutorials | Mermaid 来查看其如何支持:

  • 流程图
  • 序列图
  • 类图
  • 状态图
  • 关系图
  • 甘特图
  • 饼图
  • 象限图
  • 等等

当然,GitHub支持多种图表渲染方式,mermaid.js是其支持的其中一种。你还可以使用GeoJSON等来渲染地图,STL来做三维建模,等等。

详细使用方式,可以访问Creating diagrams – GitHub Docs查看。

类似的产品,还有plantuml (https://plantuml.com),其功能不错,不过在GitHub这个场景,不被其md支持。

另外说一个误区:相比HTML的复杂markup,我们可能以为追求简洁的markdown不支持html。其实我们完全可以在markdown里面写基本的html。

譬如,在表格的某个cell里面,我们可以签入<ul><li>这种标签来做简单的列表。