一、团队文档协作,多人协同
1、ShowDoc:API文档专属神器
Markdown写API文档,自动生成美观网页;支持电脑/手机/客户端同步,支持导出Word离线看
可以设置私密荐,防止接口泄露,多人协同
适用于:IT团队写接口文档,个人整理技术字典
github地址:https://github.com/star7th/showdoc.git
2、The Good Docs Project:文档“模板库”
现成的API文档、用户指南、贡献者手册模板,直接套用
附带行业写作技巧,如:技术文档怎么才更容易懂,社区版还在更新
适用于:新项目启动写文档,想规范团队文档风格的开发团队
github地址:https://github.com/thegooddocsproject/templates.git
3、MinDoc:轻量型文档管理,部署简单
Golang开发的,比php项目部署快,支持markdown和HTML两种编辑方式
可以存储数据字典、项目笔记,还可以看文档修改历史
适用于:中小型IT团队,不想折腾复杂部署的个人
github地址:https://github.com/mindoc-org/mindoc.git
二、个人博客/知识库
1、Halo,国产博客系统
Github超20Kstar,开箱即用,有很多免费主题,即使更换风格也不用改代码
支持插件(评论、搜索、图片等等),稳定、高效
适用于:想要搭建个人博客的程序员,喜欢java生态的开发者
github地址:https://github.com/halo-dev/halo.git
2、MrDoc 私有化“语雀”
能自己部署的语雀,存笔记、建知识库都可以,数据存在自己的服务器里
支持markdown编辑,可以上传附件(文档、图片等等)
适用于:不想把笔记存在第三方平台的个人,小团队私有知识库
github地址:https://github.com/zmister2016/MrDoc.git
三、文档预览
1、kkFileView,浏览器里预览文档
Word、Excel、PPT、XMind甚至压缩包,不用下载,浏览器中直接点开就能预览
可以集成到自己的系统里,如:团队文档平台加预览按钮
适用于:需要在线共享文档的团队,做在线教育/课件
github地址:https://github.com/kekingcn/kkFileView.git
总结:
写博客:Halo(主题多,稳定)
写API文档:ShowDoc(权限管理全)
自己管数据:MrDoc(私有化部署)
在线预览文档:kkFileView(方便、高效、快捷)