新项目中,无论是团队之间的设计方案,或者分享,都需要一个平台来托管,但又不方便公开。一开始我们是在自己搭建的gitlab里的wiki写的,有两个很不方便的地方:

  1. 文档是分类的,需要相应的目录嵌套,同时可能是多个项目的,而gitlab的wiki不支持目录嵌套,更没有多个项目的说法

  2. 最最不能忍受的就是居然不支持中文,简直就是种族歧视!说好的unicode呢?

我们团队一直在寻找这样的框架,用markdown写文档,最好是有界面,方便书写,保存;同时又可以托管在git上。当markdown遇上git,写文档相信会是有意思的一件事。

而其实自己实现一个也并非个难事,花满树团队是一个充满创造力和活力的团队,决定自己开发一个markdown文档框架,实现团队想要的功能。

邮件收集了功能列表:

  • Markdown语法

  • 支持多项目

  • 任意定义目录嵌套、定义文档,目录与文档均可中文

  • 修改后实时展现,最好没有编译

  • 多模板支持,可以换皮肤最好

  • 图片、附件上传,自动生成url

  • 文档、图片、附件能同步保存至git

  • 当然,最好不需要数据库,配置不复杂,使用简单,内部反馈不错可以开源:)

好吧,我们必须要起一个还不错的框架名字,在各个doc打头的名字中,都没有walden瓦尔登人气高,一票通过瓦尔登项目,接下来就需要在工作之余快速开发瓦尔登,一个开源文档就这么开始了。

团队大概开发了三天就完成了流畅版本,在内部开始试用,还特意做了个官方介绍,线上体验Demo

高大上的文档预览界面,大家可能会喜欢的bootstrap皮肤

大家可能会喜欢的bootstrap皮肤

清爽的编辑页面,目前是最简洁的界面了,可能会引入stackedit,方便一些对markdown不太了解的同学

清爽的编辑页面

为方便大家能更方便了解,特意做了个gif教程

目前,在我们团队中已经广泛使用了,github项目地址:https://github.com/meolu/walden,欢迎大家试用,star、fork什么的更是欢迎:)