项目分享: 开源文档工具, mindoc & showdoc

“ 大家简单分享下2个项目:Mindoc & showdoc。看了下,相对我还是更喜欢 showDoc些。”

https://github.com/mindoc-org/mindoc

该项目所有者是lifei6671已经在2021年将项目移交给开源社区mindoc-org。现在维护工作主要由社区进行,项目基本还在稳定更新中。
官方网站:
https://doc.gsw945.com/docs/mindoc-docs

项目介绍信息:
https://atomgit.com/gh_mirrors/sh/showdoc
https://github.com/star7th/showdoc

该项目所有者是star7th, 看起来作者依然在持续更新。 而且这个工具也是PHP开发的。和MinDoc一样的起点。不过MinDoc已经用Go重写了。该工具还提供了一系列相关工具,比如RunApi等。
官方网站:
https://www.showdoc.com.cn/

项目介绍信息:
-
负责接口和服务的后端 / 中台工程师 -
需要查接口和流程的前端 / 客户端工程师 -
维护需求和业务规则的产品经理 -
做联调、回归和排错的测试同学 -
维护服务器和环境信息的运维 / SRE -
负责团队文档管理和协作的技术负责人 / 团队 Leader
看了下这个工具,showDoc 是PHP+vue, mindoc是PHP打底,用Go重写了。 2款工具都是号称“专为it团队打造”的wiki平台。风格略有差异,也差不离的样子。个人感觉ShowDoc更好看些。相对来说,这2个工具都是可以在团队内部直接使用的。 而且的确ShowDoc提供的一些工具来协助把把API转文档。
不过,我其实有个想法,有没有人做一个支持, 把Swagger.json文件转换成markdown格式,然后我们就可以把它转换到很多工具中去了。。。这条线能直接打通否? 哈哈。比如先把 swagger.json 转markdown,然后通过md 就可以直接转成可以复制后到处粘贴的富文本了。

封面图片:

夜雨聆风
