【文件属性】:
文件名称:markdoc:带有流程图和序列图的Markdown
文件大小:28KB
文件格式:ZIP
更新时间:2021-02-02 18:24:10
svg markdown documentation pseudocode MarkdownRuby
马克多克
带有序列图和流程图支持HTML转换器降价。 生成包括图表的文档具有以下优点:
文档可以像源代码一样签入版本控制中,并且可以有效地比较更改,因为它们都是文本
使用绘图软件制作和更新图表很慢
它使用转换图表的markdown代码块。 Graphviz的伪代码受此启发。 伪代码被转换为点文件,然后Graphviz的dot程序将其转换为矢量图像。
系统要求
Ruby 1.9.2及更高版本
Graphviz(经点版2.38.0测试)
OS X
$ brew install graphviz
Linux(deb)
$ apt-get install graphviz
Linux(fedora,rhel或centos)
$ yum install graphviz
正在安装
$ gem install markdoc
对于捆绑器,请将gem markdoc添加到您的Gemfile中。
用法
$ markdoc document.md > document.html
生成的html包含嵌入式svg图,从而无需附加的图像文件。 它提供3个可执行文件:
markdoc将mar
【文件预览】:
markdoc-master
----lib()
--------markdoc()
--------markdoc.rb(269B)
----Gemfile(39B)
----Rakefile(514B)
----examples()
--------doc.html(26KB)
--------flowchart.svg(11KB)
--------doc.md(2KB)
--------sequence.svg(6KB)
--------example.pseudo(341B)
--------example.sequence(567B)
----test()
--------test_pseudocode.rb(989B)
--------test_sequence.rb(2KB)
----README.md(5KB)
----css()
--------pygments.css(3KB)
--------style.css(4KB)
----.gitignore(36B)
----bin()
--------sequence2svg(296B)
--------markdoc(115B)
--------pseudo2svg(215B)
----markdoc.gemspec(1KB)