首先提几句Markdown的事情,自从用了Markdown之后,就很少用其他编辑器写东西。有时候写个代码demo都直接用MarkDown写,基本支持所有编程语言的语法高亮,写起来也特别舒服。
支持MarkDown的语法工具很多,常见的有Mou,MacDown,MarkdownPad,Cmd Markdown等。Mou,MacDown是Mac下最出名的,MarkdownPad是Windows下的,Cmd Markdown是WEB版。当然还有很多博客系统提供在线Markdown编辑。比如csdn,简书……试用了多款Markdown渲染工具之后,最后不离手的只有MacDown,因为她渲染出来的界面特别符合个人的style。不足之处就是左右屏幕滚动不是百分百联动,比如我写到第100行了,右边的渲染页面已经跳到200行,不过这点小瑕疵还是能接受。
平时我会用Markdown写邮件(写出来的邮件特别漂亮,看你邮件的人心情也会很好),写会议纪要(写完就能马上分享),写博客(比如这篇),写接口文档。
自从用Markdown写接口文档之后,就存在创建索引目录的问题。因为接口文档内容层级非常的多,这种场景下就需要文档索引(目录),免得阅读的时候要翻阅好久。为什么不用word写接口文档?我个人觉得用pdf展示文档是比用word更”洁净”一些,word上会显示各种杂七杂八的颜色,符号等信息。所以我开始寻找解决方案,想把Markdown导出为带目录索引的pdf;
找了很久,终于找到一款叫wkhtmltopdf的工具,它能把html转换成带目录索引的pdf。所以我先通过MacDown导出html,再通过wkhtmltopdf把html转换成pdf,最后共享给团队的就是一份big超级高的接口文档。不过wkhtmltopdf导出pdf的速度比较慢,一页pdf要5秒的样子。
上面的排版有点乱,为的是给大家展示Markdown常用的一些格式,通过这些格式我们能高效的做出美观的文案;