ShowDoc:一款让IT团队告别文档混乱的开源利器

一、ShowDoc 是什么？

ShowDoc 是一个非常适合IT团队的在线API文档和技术文档工具。

它的诞生源于一个痛点——每个开发者都经历过的噩梦：

"当我们接手别人开发的模块或项目时，看着没有注释的代码总会崩溃——文档在哪？！Show me the doc!!"

ShowDoc 正是这句话的答案。它让团队的 API 文档、数据字典、技术说明文档集中管理、在线共享，彻底告别 Word 文件满天飞、文档版本对不上的混乱局面。

基本信息	详情
GitHub	star7th/showdoc
官网	www.showdoc.com.cn
Star	12.8k+
最新版本	v3.8.4
开源协议	Apache2（免费使用，保留版权可二次开发）
技术栈	PHP + Vue + JavaScript

二、ShowDoc 的核心优势

1. 开箱即用的三大场景

ShowDoc 天生为 IT 团队设计，开箱即用三大核心场景：

场景	说明
API 文档	快速编写精美的接口文档，支持前后端协作，请求参数、返回示例一目了然
数据字典	直观展示数据库表结构及各字段定义，新人接手项目不再抓瞎
技术文档	编写工具说明、技术规范、项目文档，团队随时查阅

2. Markdown 编辑 + 模板一键插入

采用 Markdown 编辑器，编辑和阅读体验都很优秀
内置 API 接口模板和数据字典模板，一键插入，减少重复编辑工作量
对于习惯了 Markdown 的开发者来说，几乎没有学习成本

3. 精细的权限管理

权限类型	说明
公开项目	任何人可通过链接访问，适合对外发布的接口文档
私有项目	需登录访问，密码由项目 Owner 设置
成员管理	可添加/删除成员，成员可编辑文档但不可转移或删除项目
项目转移	Owner 可自由将项目转让给他人

4. 历史版本管理

支持查看文档的历史版本
可一键恢复到任意历史版本
不再担心误删内容或修改后想回退

5. 多端适配 + 离线导出

响应式网页设计，电脑和手机都能流畅阅读
支持将整个项目导出为离线 Word 文档，断网也能看

6. 部署方式灵活，数据完全自主

ShowDoc 支持 Docker 部署和手动安装两种方式，数据存储在你自己的服务器上，不存在第三方泄露风险。与在线 SaaS 文档平台相比，这一点对于注重数据安全的企业至关重要。

优势总结

对比维度	ShowDoc	在线SaaS文档平台	纯Word/Wiki
数据安全性	✅ 完全自主可控	❌ 数据在第三方	✅ 自主
部署难度	✅ 一键脚本/Docker	✅ 无需部署	✅ 无需部署
API文档模板	✅ 内置	⚠️ 部分支持	❌ 需手动制作
权限管理	✅ 精细化	✅ 一般支持	❌ 弱
版本管理	✅ 支持	✅ 支持	❌ 靠文件命名
多端适配	✅ 响应式	✅ 支持	⚠️ Word体验差
费用	✅ 免费开源	❌ 通常收费	✅ 免费

三、搭建方法

ShowDoc 提供了多种搭建方式，从最简单的一键脚本到灵活的手动安装，总有一款适合你。

方式一：一键脚本安装（推荐，最简单）

这是官方最推荐的方式，基于 Docker，一行命令搞定。

前置条件

一台 Linux 服务器（CentOS / Ubuntu / Debian 均可）
如果没有安装 Docker，脚本会自动尝试安装

安装命令

# 安装中文版curl -fL https://www.showdoc.cc/script/showdoc | bash# 安装英文版curl -fL https://www.showdoc.cc/script/showdoc | bash -s en

脚本会自动完成：Docker 环境检查 → 镜像拉取 → 容器启动，全程无需手动干预。

安装完成后

项目	信息
访问地址	`http://你的服务器IP:4999`
数据存储目录	`/showdoc_data/html`
默认账号	`showdoc`
默认密码	`123456`

⚠️ 安全提醒：登录后请立即修改默认密码！

常用维护命令

# 停止 ShowDoccurl -fL https://www.showdoc.cc/script/showdoc | bash -s stop# 重启 ShowDoccurl -fL https://www.showdoc.cc/script/showdoc | bash -s restart# 升级到最新版本curl -fL https://www.showdoc.cc/script/showdoc | bash -s update# 卸载 ShowDoccurl -fL https://www.showdoc.cc/script/showdoc | bash -s uninstall

方式二：手动 Docker 部署

如果你习惯自己管理 Docker 容器，可以手动操作：

# 拉取镜像docker pull star7th/showdoc# 创建数据目录mkdir -p /showdoc_data/htmlchmod 777 -R /showdoc_data# 启动容器docker run -d \  --name showdoc \  -p 4999:80 \  -v /showdoc_data/html:/var/www/html \  star7th/showdoc

启动后访问 http://你的服务器IP:4999 即可。

方式三：手动安装（无 Docker 环境）

如果你的服务器不支持 Docker，可以手动搭建 PHP 环境部署。

环境要求

组件	要求
PHP	7.0+
Web 服务器	Nginx 或 Apache
数据库	SQLite（默认）或 MySQL

安装步骤

下载源码

git clone https://github.com/star7th/showdoc.gitcd showdoc

配置 Web 服务器

Nginx 参考配置：

server {    listen       80;    server_name  your-domain.com;    root         /path/to/showdoc;    index        index.php index.html;    location ~ \.php$ {        fastcgi_pass   127.0.0.1:9000;        fastcgi_index  index.php;        fastcgi_param  SCRIPT_FILENAME  $document_root$fastcgi_script_name;        include        fastcgi_params;    }    location / {        try_files $uri $uri/ /index.php?$query_string;    }}

chmod -R 777 /path/to/showdoc

访问安装页面

浏览器打开 http://your-domain.com，按页面引导完成安装。

更多手动安装细节请参考官方文档：DeployManual.md

四、快速上手指南

搭建完成后，三步快速开始：

第一步：创建项目

登录后台 → 点击「新建项目」→ 选择公开或私有 → 设置项目名称。

第二步：使用模板创建文档

进入项目 → 点击「新建页面」→ 选择模板：

API 接口模板：自动生成请求方式、URL、请求参数、返回示例等结构
数据字典模板：自动生成表名、字段名、类型、说明等表格结构

第三步：分享与协作

分享给团队：添加成员，分配编辑权限
对外分享：公开项目，生成分享链接
导出备份：导出为 Word 离线文档

五、适用人群

ShowDoc 特别适合以下团队：

📌 前后端协作团队：API 文档统一管理，接口变更实时同步
📌 接手遗留项目的开发者：用数据字典快速梳理数据库结构
📌 技术团队负责人：统一管理技术规范、项目文档
📌 注重数据安全的企业：私有化部署，数据完全自主
📌 开源项目维护者：公开项目展示 API 文档，降低使用门槛

六、总结

维度	评价
上手难度	⭐⭐（一键脚本，极简部署）
功能完善度	⭐⭐⭐⭐（API文档、数据字典、权限管理、版本管理）
社区活跃度	⭐⭐⭐⭐⭐（12.8k Star，177个版本，持续迭代）
数据安全性	⭐⭐⭐⭐⭐（私有化部署，完全自主）
开源友好度	⭐⭐⭐⭐（Apache2协议，免费可二次开发）

如果你正在寻找一款免费、开源、可私有化部署的团队文档管理工具，ShowDoc 值得一试。

一行命令，十分钟搭建，让你的团队文档从此井井有条。

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

官网：https://www.showdoc.com.cn

在线 Demo：https://www.showdoc.com.cn/demo-en