在docfx中,最重要的就是生成文档,把markdown文件(gfm语法)转换成html。

  为了这一步,我们找了N个.net开源项目,发现要么是common markdown的,要么不容易扩展,没有一个是基于gfm的并且很容易扩展的语法的markdown开源项目。无奈之下,再找.net下执行js的engine,结果发现要么用jint这个解释engine慢慢跑,要么就不能跨平台,或者就各种问题。哎,真是让人抓狂啊。。。

  走投无路之下,还是自己写一个吧,把marked.js的逻辑先翻译一遍,参考了各个版本的c#版markdown实现,接着各种重构修改再重构后,终于成型了,这就是docfx中使用的自制markdown engine-----MarkdownLite。

  因为没有时间写文档,现在的api文档几乎还是一片空白,只有类型等基本信息。在稍后的一段时间内,我们会补上文档。

  关于源代码:MarkdownLite的源代码将与docfx的源代码一起开源

  关于nuget:请搜索关键字Microsoft.DocAsCode.MarkdownLite

posted on 2015-12-18 20:00  Zhenway  阅读(2031)  评论(0编辑  收藏  举报