Markdown编写带图开发文档

使用mackdown编写开发文档时绕不过去的一道坎就是uml图,一图抵千言。怎么能高效有趣的搞定这件事情呢。答案是使用plantUML 。plantuml除了可以绘制标准的uml图之外,还能绘制界面布局图、结构图、甘特图乃至于数学公式等。可谓“plantuml在手,天下我有”。

在Visual Code和Atom中使用

在Visual Code和Atom中使用的时候要安装一个插件 Markdown Preview Enhanced然后就可以愉快的使用markdowm编写带图的开发文档了。

在pycharm中使用

要安装plantUml和Paste Images into Markdown 这两个插件。先使用plantuml画图,然后把图复制粘贴到markdown文档中。

使用pendoc输出文档

在Mac下可以使用brew安装pendoc和ImageMagick来输出word、pdf等格式。

$ brew install Graphviz
$ brew install ImageMagick
$ brew install pandoc

你可能感兴趣的:(Markdown编写带图开发文档)