美文网首页Markdown
Markdown编写带图开发文档

Markdown编写带图开发文档

作者: 挖宝人 | 来源:发表于2018-01-26 13:15 被阅读180次

使用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编写带图开发文档

    使用mackdown编写开发文档时绕不过去的一道坎就是uml图,一图抵千言。怎么能高效有趣的搞定这件事情呢。答案是...

  • Markdown 编写规范

    Markdown 编写规范 此为前端开发团队遵循和约定的 Markdown 编写规范,意在提高文档的可读性。 说明...

  • 001-Markdown 语法

    markdown 语法 兼容 HTML 例: 效果: 欢迎使用Markdown 文档格式编写文档! 1. 区块元素...

  • markdown文档编写

    Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式...

  • 【转】Markdown 编写规范

    此为前端开发团队遵循和约定的 Markdown 编写规范,意在提高文档的可读性。 1. 说明 文档中使用的关键字「...

  • 七牛云图床提示域名失效2018-11-11

    问题: 我以前写文章都是用七牛云把MPic图床神器作为图床,用作markdown文档编写,原先使用正常,但最近访问...

  • Markdown学习笔记

    Markdown基本用法 总览 这是我第一篇 MarkDown*编写的文档。Markdown中#号表示标题,##表...

  • 第一天全栈介绍及所需具备的能力与知识

    一、学会写文档atom用markdown编写markdown的文档(作业) 二、以下是学习笔记 什么是全栈工程师:...

  • Markdown基本语法

    什么是Markdown? Markdown是一种轻量级的"标记语言",它以纯文本形式编写文档。Markdown的语...

  • Markdown简明教程

    Markdown 编写的文档后缀为 .md, .markdown。 编辑和预览模式的切换快捷键 Ctrl + / ...

网友评论

    本文标题:Markdown编写带图开发文档

    本文链接:https://www.haomeiwen.com/subject/tmwiaxtx.html