之前因为工作的关系,用 HTML 记录文档,实在太 low 了。之后一直想找个好用的文档管理系统。要求其实也不太多,重要的就下面几点。
- 文档格式为文本格式,方便进 git,做版本管理、review 及回溯;
- 支持文本指令画 UML、流程图、架构图等等图解。图解同样需要进 git 管理;
- 方便上传图片并插入到指定位置,能简单控制图片格式更好;
- 支持 TOC(Table Of Contents,章节目录);
- 支持文档间跳转,类似 wiki;
- 支持搜索并跳转,可以接受依赖于第三方搜索系统(如:ElasticSearch)的方案;
其中前四条可以用 markdown 类写作工具来解决,很多 markdown 写作工作都支持上述的功能,例如:简书、作业部落、sublime text等等。倒是第五条开始,支持得就比较少了,至于第六条,能做到的真是凤毛麟角。
gitbook 一直是我个人比较喜欢的一个工具:支持插件,扩展起来相对容易;基于 git + markdown,工具栈通用;支持章节管理和页面间跳转。虽然现在看起来没有比较好用的搜索插件,但自己开发一个也不是太难的事情。
于是最近试了试用 gitbook 来写一个简单的文档。目录中只有三个页面。写作的编辑器我选择了 gitbook 自带的 mac 版本 editor。
可惜,用之后我真的非常惋惜和遗憾。
也许是编辑器自己的问题,总是跳屏。在文档最末写着写着,整个屏幕自动翻页到文首,看不到光标。你接着输入,屏幕又跳回到文末,你还能看到你输入的内容——光标就没动过,动的只有屏幕。
一款跳屏的软件,还想对用户收取月 $7 的费用,真的也是醉了。
gitbook 是一个好的工具,同时它更是一个好的标准,借助 git + markdown 两个开放性的玩意,加上自己的 plugin 机制,给写作的人一个好的工具框架,支持全文本输入,把诸如
word 一类编辑器打成渣渣没问题。但如果不珍惜这么好的机遇,只是想着自己家赚钱,越做越小气,这么多年了,连最基本的问题都不能好好解决,除了『作死』,找不到更好的词送他们。
PS:我还会继续找这么一个好用的文档管理系统。gitbook 作为一种写作的方式或者说标准我也还会接着考虑。只是不会再用 gitbook 家自己的编辑器以及线上服务了。