虽然文档的生成,已经有一些现成的工具,比如
https://readthedocs.org/但是我们想要有更轻便的体验,这样文档维护起来就会轻松很多。所以在开发FarBox的时候,有时候也会顺带做一些额外功能,来支持我们自己的文档库
doc.farbox.com 我们内部已经使用了比较长时间,还是比较稳定地在工作着。简单的说,就是基于Dropbox的数据同步,FarBox的API自定义模板,以及FarBox Editor导出PDF。
至于特性,比如自动生成的菜单、TOC支持、代码高亮、全文检索、文件夹对应的landing page .etc,本身都是FarBox引擎支持的,所以,Web端出来的站点也有这些特性, 除去css外的模板代码大概60行左右。
几副截图:
本地的文件夹结构:
对应的网站模板 https://doc.farbox.com :
具体的源码与使用方法参见: https://github.com/BuildFarBox/doc.farbox.com/blob/master/readme-cn.markdown
FarBox Editor导出的PDF文档其中的一索引页, 具体PDF可以到 https://doc.farbox.com 上下载。
这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。
https://www.v2ex.com/t/108935
V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。
V2EX is a community of developers, designers and creative people.