适合技术团队使用的文档工具ShowDoc安装及使用教程,支持创建API、数据字典、教程等 | 开源管理

01

ShowDoc简介

ShowDoc是由第七星尘@star7th使用PHP语言开发的一款适合技术团队使用的开源文档工具，适合用于API文档、数据字典、技术规范、团队知识库等，多个大厂内部均有应用，100%开源，提供云服务版本，日常使用网页端即可，也提供PC端和手机端，主要功能有：

• 支持文档项目管理，提供常规、单页、表格、白板、看板等不同类型的项目，支持项目归档和转让

• 默认采用Markdown语言，支持PlantUML扩展

• 文档支持历史版本对比和回滚，支持克隆页面

• 支持自家的RunApi工具一键自动生成API接口文档

• 用户和权限方面，支持划分团队，提供支持LDAP/OAuth2接入

• 支持AI服务，集成MCP，可在后台-用户中心生成AI令牌

02

ShowDoc安装

【使用phpEnv安装】

由于ShowDoc数据库使用的是sqlite，需要启用sqlite扩展，PHP版本支持7.4～8.5：

进入首页需先选择语言为中文，随即初始化完成，默认账号为showdoc，密码为123456：

【使用Docker安装】

先创建工作目录：

mkdir -p /home/showdoc_data/htmlchmod  -R 777 /home/showdoc_data

然后运行这条命令：

docker run -d --name showdoc --restart=always --privileged=true -p 4999:80 -v /home/showdoc_data/html:/var/www/html/ star7th/showdoc:v3.9.2

后续操作与前面一致。

03

ShowDoc使用

支持创建常规项目：

单页项目：

表格项目：

白板项目：

看板项目：

其实感觉像是缝合怪，什么都往里塞。（不是）

我们以常规项目为例，在规划好文章架构后，先添加目录，再添加页面，选择对应目录：

页面内容编辑为双栏实时预览模式，支持思维导图、流程图、时序图等等：

提供历史版本对比：

搜索支持全文搜索：

权限划分为简单的编辑、只读、项目管理员，页面权限范围支持所有页面和一级目录：

支持LDAP和OAuth2认证登录：

集成了AI助手功能：

不过我这里没配置成功，作者在Github社区中回复的阿里云的地址为：

https://dashscope.aliyuncs.com/compatible-mode

修改后也未成功。

04

自动生成接口文档

RunApi也是ShowDoc旗下的另一款产品，类似于Postman、Apifox，可以实现自动生成接口文档并填入ShowDoc实例，是exe程序，安装运行即可。

初次运行需绑定ShowDoc实例：

经过测试的接口可以一键生成文档：

ShowDoc项目名称对应RunApi的项目名称：

05

ShowDoc获取

关注公众号，后台回复showdoc获取php语言源码包和RunApi安装包