开源的大模型知识库搭建系统，用于快速构建产品文档、技术文档、FAQ 和博客，并提供 AI 创作、问答与搜索。
1万+51 本周1043TypeScriptAGPL-3.0更新于 前天
- Star
- 12,872
- Fork
- 2,212
- 未关闭 Issue
- 235
- 最近提交
- 4天前
这是什么？
ShowDoc 是一款面向软件团队的在线文档分享工具，解决接手他人代码时缺少文档、Word 文档分散维护且很快过时的问题。
它主要用于三类文档：API 接口文档（可通过模板快速生成接口页面）、描述数据库字段含义的数据字典，以及工具说明和技术规范等说明类文档。页面使用 Markdown 编写，每个页面保留历史版本，可以随时恢复。项目分为公开和私有两种，支持转让和添加成员，也可以导出为离线 Word 文档。
ShowDoc 支持部署在自有服务器上，项目提供了安装教程，并针对自托管的 Nginx 和 Apache 用户给出了安全加固说明。
核心功能
- 01内置 API 接口和数据字典模板，快速生成页面。
- 02Markdown 编辑器，每个页面保留历史版本。
- 03支持公开和私有项目，可管理成员并转让项目。
- 04响应式页面，电脑和手机都能阅读。
- 05可将项目导出为离线 Word 文档。
- 06支持部署在自有服务器上。
适用场景
- 为后端接口编写文档，方便前端和移动端开发者对接。
- 维护数据库数据字典，说明每个字段的含义。
- 为团队编写内部工具使用说明或技术规范。
- 接手缺少文档的旧项目时整理接口和说明。
快速上手
- 1
按照 AutoInstall 指南在自有服务器上部署
使用前须知
- 需要自行托管，使用 Nginx 或 Apache 的用户必须禁止访问 Sqlite/ 目录以保障安全。
- 元数据中的许可证标注为 NOASSERTION，且 README 在 Apache 2.0 之外增加了版权条款，要求保留界面上的版权信息和链接。
收录于专题
标签
常见问题
- showdoc 是什么？
- 面向 IT 团队的在线文档工具，主要用于 API 文档、数据字典和 Markdown 团队知识库。 ShowDoc 是一款面向软件团队的在线文档分享工具，解决接手他人代码时缺少文档、Word 文档分散维护且很快过时的问题。
- showdoc 可以免费使用吗？用的什么许可证？
- showdoc 以 Other 许可证开源。用于商业产品前，请先确认许可证条款。
- showdoc 还在维护吗？
- 活跃维护中。showdoc 最近一次提交是在 2026年11月3日。
- showdoc 适合用来做什么？
- 为后端接口编写文档，方便前端和移动端开发者对接。 维护数据库数据字典，说明每个字段的含义。 为团队编写内部工具使用说明或技术规范。 接手缺少文档的旧项目时整理接口和说明。
- showdoc 怎么安装和运行？
- 按照 AutoInstall 指南在自有服务器上部署
- 在哪里获取 showdoc？
- 源代码和安装说明在 GitHub 上：https://github.com/star7th/showdoc
概要由 AI 根据项目 README 生成；GitHub 数据每日更新。
相关项目
开源的协作式 Wiki 与文档软件，可作为 Confluence 和 Notion 的开源替代方案。
2.2万+79 本周1674TypeScriptAGPL-3.0维护活跃更新于 18小时前
自托管 Wiki，单个 Go 二进制文件运行，使用 SQLite 和磁盘上的 Markdown 文件，无需外部数据库。
1218+13 本周102GoMIT维护活跃更新于 20小时前
一款可自托管的免费笔记应用，支持富文本与 Markdown 笔记、任务列表和日记，可替代 Notion 等工具。
995+22 本周49JavaScriptMIT更新于 18小时前
用 Go 编写的无数据库自托管 Wiki，所有页面以纯 Markdown 文件保存在本地。
62556GoGPL-3.0维护活跃更新于 前天
把 Markdown 笔记、文档和知识库几秒钟发布成网站，支持拖拽、Obsidian、GitHub 和面向 AI 的命令行工具。
1111+2 本周120TypeScriptAGPL-3.0维护活跃更新于 4天前