大家好，我是 Java陈序员。

在日常开发中，常常需要编写接口文档，供第三方查阅调用，文档传来传去很麻烦，且不好维护！

今天，给大家介绍一款在线的文档管理工具，十分适合 IT 团队使用！

关注微信公众号：【Java陈序员】，获取开源项目分享、AI副业分享、超200本经典计算机电子书籍等。

项目介绍

ShowDoc —— 一个非常适合 IT 团队的在线 API 文档、技术文档工具，适合用于团队协作、知识库建设、个人博客和教程分享等。

功能特色：

• 文档类型：支持生成 API 文档、数组字典、说明文档等
• 文档编辑：支持 Markdown 语法，提供 API 接口模板和数据字典模板，减少编辑工作量
• 权限管理：具备详尽的项目管理、成员管理功能
• 版本管理：提供历史版本功能，方便查看并恢复之前的版本，便于追踪文档的修改记录
• 分享导出：项目文档支持生成链接分享推广，也支持导出为离线的 Word 文档
• 私有化部署：支持脚本、Docker、宝塔等多种私有化本地部署

安装部署

ShowDoc 支持脚本、Docker、宝塔、Windows 多种安装方式，使用 Docker 部署会更加简便。

1、拉取镜像

docker pull star7th/showdoc:latest 

# ARM 版本的镜像
docker pull star7th/showdoc:arm-latest

# 镜像拉取失败，可替换使用如下加速镜像，拉取成功后记得执行 docker tag 命令以进行重命名
docker pull registry.cn-shenzhen.aliyunccnblogs.com/star7th/showdoc

docker tag registry.cn-shenzhen.aliyunccnblogs.com/star7th/showdoc:latest star7th/showdoc:latest

2、创建存放 ShowDoc 数据的目录

mkdir -p /data/software/showdoc/html
chmod -R 777 /data/software/showdoc/

3、启动容器

docker run -d --name showdoc 
    --user=root --privileged=true 
    -p 4999:80 
    -v /data/software/showdoc/html:/var/www/html/ 
    star7th/showdoc

4、容器启动成功后，访问

http://localhost:4999

默认管理员账号密码：showdoc/123456, 登录后可以看到右上方的管理后台入口，建议登录后修改密码！

5、如需绑定域名，可使用 Nginx 进行反向代理设置

server {
    listen       80;
    server_name  test.showdoc.com.cn;
    client_max_body_size 1000m;
    location ^~ / {
        proxy_pass http://127.0.0.1:4999/;
        proxy_redirect off;
        proxy_connect_timeout 90;
        proxy_send_timeout 90;
        proxy_read_timeout 90;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header http_user_agent $http_user_agent;
    }
}

系统截图

• 首页

• 页面

• 文档编辑

• 文档分享

• 历史版本

• 团队管理

• 成员管理

• 后台管理

ShowDoc 功能齐全，完全满足一个私有化在线文档管理平台的功能需求，而且上手简单。如果想搭建一个在线文档管理平台，不妨试试 ShowDoc ~

项目地址：https://github.com/star7th/showdoc

最后

推荐的开源项目已经收录到 GitHub 项目，欢迎 Star：

https://github.com/chenyl8848/great-open-source-project

或者访问网站，进行在线浏览：

https://chencoding.top:8090/#/

我创建了一个开源项目交流群，方便大家在群里交流、讨论开源项目。

但是任何人在群里打任何广告，都会被 T 掉。

如果你对这个交流群感兴趣或者在使用开源项目中遇到问题，可以通过如下方式进群：

关注微信公众号：【Java陈序员】，回复【开源项目交流群】进群，或者通过公众号下方的菜单添加个人微信，并备注【开源项目交流群】，通过后拉你进群。

大家的点赞、收藏和评论都是对作者的支持，如文章对你有帮助还请点赞转发支持下，谢谢！