关注程序员7歌,一起用技术改变世界
showdoc:简介在线文档管理系统很多, 比如阿里的语雀、腾讯的 TAPD 平台也包括文档管理功能, 但这些系统需要联网的, 企业内文档协作工具不是很多, 最有名的是收费的 confluence 了, 禅道有文档管理功能, 但功能较弱, 比较适合附件上传管理.
这里介绍 Showdoc这款开源(免费)文档管理系统,可以部署企业内部,后台使用 php + sqlite,支持 Windows/Linux/Docker 部署形式。
showdoc 的功能:
1. 文档编辑语法采用 markdown, 编辑器做的挺不错。
2. 支持文档版本管理
3. 可以将文档导出为 word 软件格式
4. 权限控制: 可以新建公开项目和私密项目, 可以管理项目成员。
5. 文档搜索功能: 可以在一个项目搜索文档, 支持全文搜索, 但不支持跨项目的搜索。
之前的文章我们讲过自动生成接口文档,今天我将为大家讲解把工具(July Doc)生成的MarkDown格式的接口文档自动同步到showdoc管理系统。
在接口生成工具上创建showdoc实体对象ShowDocModel,用于传递showdoc参数,代码如下:
package com.july.doc.showdoc;import lombok.Data;/*** showdoc信息* @author zqk* @since 2019/12/11*/@Datapublic class ShowDocModel {/*** 标题*/private String folder;/*** 标题*/private String title;/*** 内容*/private String content