最开始是因为寻找管理接口文档的工具找到showDoc的,可以说是用了很多网站,除了showDoc其余的网站基本都让我很失望.目前我基本每天都会用showDoc,真的是超级方便。
首先看一下showDoc官方的介绍:
showDoc:一个非常适合IT团队的在线API文档、技术文档工具
API文档:APP、web前端与服务器常用API来进行交互,用showDo可以非常方便快速地编写出美观的API文档
数据字典:好的数据字典可以方便地向别人描述你的数据库结构,用showDoc可以编辑美观的数字字典
说明文档:你完全可以使用showDoc来编写一些工具说明书,也可以编写一些技术规范说明书以供团队查阅
团队协作:团队权限管理机制让团队良好地协同编写文档
免费开源:showDoc提供免费开源的版本,可以部署到自己的服务器
再看一下几张截图吧
1.首页
2.接口文档
编写简单,对于我这种强迫症可以说,这接口文档已经接近完美了
3.代码
代码放在上面也很美观
4.普通文档
包括我这篇文章都是在这上面编辑好的
5.word文档
word上面的文字看起来很恶心的放这上面就没那么恶心了
6.txt文档
txt文档放这上面也是很不错的
还有很多意想不到的功能可以尝试的用一下,然后团队管理,权限管理都很棒.然后就是可以直接部署到自己服务器,那就更美滋滋了。
另外提一点,它的编辑器是markdown,这个编辑器也是超级棒。反正我只会一些基本的操作,功能是在太强大了,可以百度自行摸索怎么使用。
领取专属 10元无门槛券
私享最新 技术干货